我目前正在写一份正式的研究报告，我将在这份报告中包含代码。
问题：在研究报告中显示代码是否有一种可接受的方式？我在考虑字体、间距等方面，以及代码是否应该显示在文档中或附录中。
代码将是 JavaScript 和 PHP。代码的任何部分都不会超过 25 行（所以它们只是片段）。大约会有六个片段。每个片段都会有几段解释代码中发生的事情，并讨论其优缺点。
我与将向其提交报告的机构没有联系，他们也没有发布关于如何格式化代码的指南（请不要质疑这些点）。
问问题
21680 次
6 回答
7
好吧，这取决于您的论文所写的样式指南要遵守...
通常代码应该以单型字体编写，以便易于阅读（例如 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
于 2010-03-18T06:20:52.927 回答
4
这是我的偏好：
在编写内联代码时，去掉与解释无关的代码（例如前面提到的 import 语句，但可能还有“显而易见”的变量声明等）。内联代码的目标应该是便于与描述该代码块的段落进行交叉引用。
放在附录中的代码应该是完整的（如 - 您可以将其放入编译器并按 go）。
不要害怕在片段中放置大量缩减的代码，以及对包含完整代码的附录的引用 - 附录代码供某人单独阅读/运行。内联代码供人们浏览并帮助理解该部分的具体点。
于 2010-03-21T16:37:28.433 回答
2
我会说带有标准文本间距和标准行间距的 Courier 字体，全黑文本，适当的缩进。
就代码本身而言，省略import语句，注释都可以。您可能希望在代码中添加脚注（如 {1}、{2}）作为注释，并在下面解释代码的文本中引用。
本文在第 6 页上有一个示例：
http://www.eecs.berkeley.edu/Pubs/TechRpts/2006/EECS-2006-1.pdf
于 2010-03-18T06:21:38.823 回答
2
我意识到这是一个老问题，但不要忘记给代码中的行编号！对于单行，可以跳过数字，但任何更大的数字，几乎都是必需的。
于 2010-05-07T23:30:26.477 回答
0
如果您正在撰写研究报告，您应该使用 LaTeX。
我通常使用 LaTeXvancyvrb包和Verbatim.
但是，另一种选择是使用该listings软件包。lstinputlisting它可以直接使用命令输入文件。它会自动为您的行编号并使用 _ 字符而不是空格字符，但这是可编程的。这真的很不错。
于 2010-03-18T06:26:06.337 回答