Как форматировать код в [закрытых] отчетах по результатам исследования
6 ответов
Ну, это зависит от того, в соответствии с каким руководством по стилю написана ваша статья ...
Обычно код должен быть написан монотипным шрифтом, чтобы его было легко читать (Например, Lucida Sans Console или Courier New). Это означает, что все буквы занимают одинаковое место на странице.
Когда я написал фрагменты для публикации, я сделал отступ на 2,5 см сбоку и сделал его светло-серым фоном шрифтом Lucida Sans Console ... Следуя отступам кода в стиле C.
Я хотел бы спросить ваше учреждение, есть ли у них руководство по стилю, но, поскольку у вас нет такой способности, воспользуйтесь популярным руководством по стилю, таким как Гарвардская система, и убедитесь, что вы следуете одному и тому же формату.
Вот список журналов из Google Scholar со стилем отображения: http://scholar.google.com.au/scholar?hl=en&q=PHP+SQL+programming+journal&btnG= Искать & as_sdt = 2000 & as_ylo = & as_vis = 0
Если вы пишете исследовательский отчет, вам следует использовать LaTeX.
Обычно я использую пакет LaTeX vancyvrb и Verbatim.
Однако есть и другой вариант - использовать пакет listings. Он может вводить файл напрямую с помощью команды lstinputlisting. Он автоматически нумерует строки и использует символ _ вместо пробела, но это можно запрограммировать. Это действительно очень удобно.
Это мое предпочтение:
При написании встроенного кода избавьтесь от кода, не имеющего отношения к объяснению (например, операторов import как упоминалось ранее, но потенциально также могут быть объявлены "очевидные" переменные и т.п.). Целью встроенного кода должно быть облегчение перекрестной ссылки с абзацем, описывающим этот блок кода.
Код, помещенный в приложения, должен быть полным (например, вы можете поместить его в свой компилятор и нажать кнопку «Go»).
Не бойтесь размещать сильно урезанный код во фрагментах вместе со ссылкой на приложение, содержащее полный код - код приложения предназначен для того, чтобы кто-то читал / запускал отдельно. встроенный код предназначен для того, чтобы люди могли взглянуть на него и помочь понять конкретный момент этого раздела.
Я бы сказал, шрифт Courier со стандартным интервалом между текстами и стандартным межстрочным интервалом, полностью черный текст, правильный отступ.
Что касается самого кода, опустите операторы импорта, комментарии - это нормально. Вы можете добавить примечания типа {1}, {2}, inline в код в виде комментария и ссылки ниже в тексте, поясняющем код.
В этой статье есть пример на странице 6:
http://www.eecs.berkeley.edu/Pubs/TechRpts/2006/EECS-2006-1.pdf
Я понимаю, что это старый вопрос, но не забудьте пронумеровать строки в вашем коде! Для однострочников можно пропускать числа, но если они больше, они почти обязательны.
Что сказали Джей Ди и Бен.
Вы должны использовать соответствующую установленную подсветку синтаксиса. Пакет Latex listings , упомянутый vy32, имеет стили подсветки синтаксиса как для Javascript, так и для PHP, как и программа Pygments , которая выводит, среди прочего, Latex, HTML и RTF.