如何格式化研究报告中的代码[已关闭]

这取决于你的论文是按照哪种风格写的…

通常,代码应该以单字字体编写,以便易于阅读(例如Lucida Sans控制台或Courier New)。这意味着所有字母在页面上占据相同的空间。

当我写了一些要发布的代码时,我从侧面缩进了2.5厘米的代码,并给它一个浅灰色的背景,使用Lucida Sans控制台字体…遵循C样式代码缩进。

我会问你的机构是否有风格指南,但由于你缺乏这种能力,请使用流行的风格指南,如哈佛系统,并确保你始终遵循相同的格式。

以下是来自谷歌学者的日志列表,显示样式: http://scholar.google.com.au/scholar?hl=en&q=PHP+SQL+programming+journal&btnG=Search&as_sdt=2000&as_ylo=&as_vis=0

这是我的偏好:

在内联编写时,去掉与解释无关的代码(如导入 如前所述,但也可能是“明显”的变量声明等)。内联代码的目标应该是便于与描述该代码块的段落交叉引用。

附录中的代码应该是完整的(如-中所示,您可以将其放入编译器并按Go键)。

不要害怕将大量削减的代码放在代码片段中,同时引用包含完整代码的附录-附录代码供某人单独阅读/运行。内联代码供人们浏览并帮助理解该部分的特定点。

我会说Courier字体有标准的文本间距和标准的行距,所有的黑色文本,适当的缩进。

就代码本身而言,省略import语句,注释是可以的。您可能需要在代码中添加诸如1,2之类的脚注,作为注释和下面解释代码的文本中的引用。

本文在第6页有一个例子:

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

我知道这是一个古老的问题,但不要忘记给代码中的行编号!对于一行程序来说,可以跳过数字,但是任何更大的数字都几乎是必需的。

如果你在写研究报告,你应该使用乳胶。

我通常用乳胶 vancyvrb 包和 Verbatim .

但是,另一种选择是使用 listings 包裹。它可以直接使用 lstinputlisting 命令。它会自动给你的行编号并使用uu字符而不是空格字符,但这是可编程的。真的很不错。

JD和本说的。

您应该使用适当的、已建立的语法突出显示。乳胶的 listings vy32提到的包具有突出显示JavaScript和PHP样式的语法,正如 Pygments 程序,其中输出到乳胶、HTML和RTF。