Как форматировать код в исследовательских отчетах

Question

В настоящее время я пишу официальный отчет об исследовании, и я буду включать код с этим отчетом.

Вопрос: Есть ли способ отображения кода в исследовательских отчетах? Я думаю как с точки зрения шрифта, интервала, так и так далее, и должен ли отображаться код внутри документа или в приложении.

Код будет JavaScript и PHP. Ни один из разделов кода не будет более 25 строк (так что это просто фрагменты). Будет примерно полдюжины фрагментов. Каждый из фрагментов будет содержать пара абзацев, объясняющих, что происходит в коде, и обсуждение его плюсов и минусов.

У меня нет контакта с органом, которому будет представлен отчет, и у них нет опубликованных рекомендаций по форматированию кода (пожалуйста, не ставьте под сомнение эти моменты).

Answer 1

Ну это зависит от того, стиль руководства вашей бумаги записываются, чтобы соответствовать ...

Обычно код должен быть написан в монотипии шрифтом, так что он легко читается (Например 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=Search&as_sdt=2000&as_ylo=&as_vis=0

Answer 2

Я бы сказал Courier шрифт со стандартным расстоянием между текстом и стандартным межстрочным интервалом, всем черным текстом, надлежащим отступом.

С точки зрения самого кода опускать импортные заявления, комментарии в порядке. Вы можете добавить нотные заметки, такие как {1}, {2}, встроенные в код как комментарий и ссылку ниже в тексте, который объясняет код.

В этой статье есть пример на странице 6:

http://www.eecs.berkeley.edu/Pubs/TechRpts/2006/EECS-2006-1.pdf

Answer 3

Если вы пишете отчет об исследовании, вы должны использовать LaTeX.

Я обычно использую пакет LaTeX vancyvrb и номер Verbatim.

Однако другой вариант заключается в использовании пакета listings. Он может вводить файл напрямую, используя команду lstinputlisting. Он автоматически отображает ваши строки и использует символ _ вместо символа пробела, но это программируется. Это действительно неплохо.

Answer 4

Это мое предпочтение:

При написании рядный, чтобы избавиться от кода, который не имеет отношения к объяснению (например, импорт заявления, как уже упоминалось ранее, но потенциально также объявления переменных, которые «очевидны» и т.п.).Цель встроенного кода заключается в том, чтобы упростить перекрестное сопоставление с абзацем, описывающим этот блок кода.

Код, помещенный в приложения, должен быть полным (как в - вы можете поместить это в свой компилятор и нажать go).

Не бойтесь помещать сильно сокращенный код в фрагменты, а также ссылку на приложение, содержащее полный код. Код приложения предназначен для чтения/запуска отдельного пользователя. встроенный код предназначен для людей, чтобы заглянуть и помочь понять конкретную точку этого раздела.

Answer 5

Я понимаю, что это старый вопрос, но не забудьте указать строки в коде! Для однострочных, это нормально пропускать числа, но что-то большее, они почти требуются.

Answer 6

Что сказал JD и Ben.

Вы должны использовать соответствующую установленную подсветку синтаксиса. Пакет Latex's listings, упомянутый vy32, имеет стили подсветки синтаксиса как для Javascript, так и для PHP, а также для программы Pygments, которая выводит, среди прочих, латекс, HTML и RTF.