Я пишу отчет и должен думать о читателе. В отчете есть код и несколько иллюстраций. Интересно, как отобразить код читабельно. Теперь я смешиваю шрифты Times New Roman 12 для обычного текста и Courier 11 для кода. Но я мог бы вместо этого написать код в LTL, линейной временной логике, что, на мой взгляд, выглядит лучше всего, но на самом деле это не обязательно и занимает много времени.
Как вы думаете, будет ли хорошо просто сохранить время new roman 12 для обычного текста и courier 11 для кода?
Если в вашем учреждении нет специального руководства по стилю для написания и форматирования кода (которого, судя по наличию этого вопроса, я предполагаю, у вас нет), говоря как человек, который пишет техническую документацию к программному обеспечению:
Обычно я использую шрифт Cambria или семейство шрифтов Serif, размер 11, интервал 0,5 для текста. Тем не менее, я получил специальное указание использовать эти шрифты.
Для кода используйте шрифт, в котором каждый символ занимает столько же места, сколько и любой другой символ. Source Code Pro — хороший пример такого шрифта.
Код должен выделяться или быть легко различимым, поэтому поместите его в рамку. Прежде всего (как упоминалось выше) форматирование кода должно быть таким же, как в IDE или текстовом редакторе, чтобы каждый символ занимал одинаковое количество места. Например,
Это программа, которая печатает "Hello World!" к консоли.
Строка s = "Привет, мир!"; System.out.println(s);
Обычно я не решался включать комментарии в блоки кода, особенно если ваш документ уже объясняет, что делает код.
Еще одна вещь, которую вы, безусловно, можете сделать, это просто сделать скриншоты кода из вашего IDE/текстового редактора, обрезать его в программе редактирования изображений и просто вставить полученное изображение в редактор документов. Это может быть удобно, так как обычно в IDE есть такие вещи, как номера строк, которые иначе недоступны в предварительно отформатированном тексте.
К сожалению, я не могу дать больше советов, поскольку, когда дело доходит до вопросов о техническом письме, ответы «это зависит». Разные учреждения имеют разные потребности, и, если честно, если они не дали вам достойного представления о том, как они хотят что-то отформатировать, они либо действуют непрофессионально, либо не слишком беспокоятся о деталях, пока сообщение доходит до людей. .
Моника Челлио