我目前正在撰写正式的研究报告，我将在此报告中包含代码。
问题：是否有可接受的方式在研究报告中显示代码？我在考虑字体，间距等等，以及代码是否应该在里面文档或附录中显示。
代码将是JavaScript和PHP。代码的所有部分都不会超过25行（因此它们仅仅是片段）。将有大约六个片段。每个片段都有几个段落，解释代码中发生的事情，并讨论其优缺点。
我与报告将提交给的机构没有联系，也没有关于如何格式化代码的公布指南（请不要质疑这些要点）。
答案 0 :(得分：6)
这取决于您的论文写入哪种风格指南以符合......
通常代码应该以单色字体书写，以便易于阅读（例如Lucida Sans Console或Courier New）。这意味着所有字母占用页面上的相同空间。
当我写了一些用于发布的内容时，我将代码缩小了2.5cm并给它一个浅灰色的背景，用Lucida Sans Console字体...跟随C样式代码缩进。
我会问你的机构是否有风格指南，但由于你缺乏这种能力，请使用流行的风格指南，如哈佛系统，并确保你遵循相同的格式。
以下是Google学术搜索的期刊列表，其显示风格： http://scholar.google.com.au/scholar?hl=en&q=PHP+SQL+programming+journal&btnG=Search&as_sdt=2000&as_ylo=&as_vis=0
答案 1 :(得分：3)
这是我的偏好：
在内联编写时，请删除与解释无关的代码（例如导入 如前所述的语句，但也可能是“明显”的变量声明等。内联代码的目标应该是与描述该代码块的段落轻松交叉引用。
附录中的代码应该是完整的（如 - 您可以将其放入编译器并按下去）。
不要害怕在代码段中放置严重删减的代码，以及对包含完整代码的附录的引用 - 附录代码供有人单独阅读/运行。内联代码供人们浏览并帮助理解该部分的具体要点。
答案 2 :(得分：2)
我会说Courier字体带有标准文本间距和标准行间距，所有黑色文本，正确的缩进。
就代码本身而言，省略import语句，注释是可以的。您可能希望在代码中内嵌脚注，如{1}，{2}，作为注释和参考，在解释代码的文本中。
本文第6页有一个例子：
http://www.eecs.berkeley.edu/Pubs/TechRpts/2006/EECS-2006-1.pdf
答案 3 :(得分：2)
我意识到这是一个老问题，但不要忘记在代码中对行进行编号！对于单行，可以跳过数字，但是任何更大的数字，它们几乎是必需的。
答案 4 :(得分：0)
如果您正在撰写研究报告，那么您应该使用LaTeX。
我通常使用LaTeX vancyvrb包和Verbatim。
但是，另一种选择是使用listings包。它可以使用lstinputlisting命令直接输入文件。它会自动为您的行编号并使用_字符而不是空格字符，但这是可编程的。这真的很不错。
答案 5 :(得分：0)