Coding style 研究报告中的代码格式

我目前正在写一份正式的研究报告，我将在这份报告中包含代码

问题：在研究报告中显示代码是否有公认的方式？我在考虑字体、间距等方面，以及代码应该显示在文档中还是在附录中

代码将是JavaScript和PHP。代码的任何部分都不会超过25行（因此它们只是片段）。大约有六个片段。每个代码片段都有几个段落来解释代码中发生的事情，并讨论其优缺点

---

我与报告将提交给的机构没有联系，他们也没有发布关于如何设置代码格式的指导原则（请不要质疑这些要点）。

这取决于你的论文所遵循的风格指南

通常，代码应使用单一字体编写，以便易于阅读（例如Lucida Sans Console或Courier New）。这意味着所有字母在页面上占据相同的空间

当我写了一些用于发布的代码时，我将代码从侧面缩进了2.5厘米，并给它一个浅灰色的背景，使用Lucida Sans控制台字体。。。下面是C风格的代码缩进

我想问一下你们的学校是否有一个风格指南，但由于你们缺乏这种能力，请选择一个流行的风格指南，比如哈佛系统，并确保在整个过程中遵循相同的格式

以下是Google Scholar提供的显示样式的期刊列表：

---

我认为Courier字体采用标准文本间距和标准行距，全黑文本，适当缩进

就代码本身而言，省略import语句，注释就可以了。您可能希望在代码中内联添加{1}、{2}等脚注，作为注释和引用，并在下面解释代码的文本中添加

本文第6页有一个例子：

---

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

我通常使用LaTeX

vancyvrb

软件包和

逐字记录

但是，另一个选项是使用

清单

包。它可以使用

lstinputlisting

命令直接输入文件。它会自动为行编号，并使用u字符而不是空格字符，但这是可编程的。真的很不错。

这是我的偏好：

在编写内联代码时，请删除与解释无关的代码（例如导入） 语句，但也可能是“明显”的变量声明等）。内联放置代码的目的应该是便于与描述该代码块的段落进行交叉引用

放在附录中的代码应该是完整的（如-您可以将其放入编译器并按go）

---

不要害怕在代码片段中放置大量精简的代码，以及对包含完整代码的附录的引用-附录代码供其他人单独阅读/运行。内联代码供人们浏览并帮助理解该部分的具体内容。

我意识到这是一个老问题，但别忘了给代码中的行编号！对于单行程序来说，跳过数字是可以的，但任何更大的数字都几乎是必需的。

JD和Ben所说的

---

您应该使用适当的、已建立的语法突出显示。vy32提到的Latex软件包具有Javascript和PHP的语法突出显示样式，该程序也具有这种样式，它可以输出Latex、HTML和RTF等格式。

感谢您的回答。对于代码是应该与文本内联还是放在附录中，您有什么想法吗？如果少于一页，我总是将代码内联，如果代码太长，则放在附录中。。如果它很长，可能也值得查看行号，那么您可以交叉引用代码。我所有需要代码或数组等的大学论文都被引用为代码1.0代码1.1等。。大家好，我在一所大学工作——通常在这里（主观！）代码的主要部分作为附录添加，报告中添加的任何代码示例。代码应该始终遵循给定的编码约定（也是主观的！），与上面的注释相同：谢谢您的回答，考虑在内。对于代码是否应该与文本或附录内联，您有什么想法吗？我会将相关章节内联以说明要点。我不同意，我发现在代码示例中，如果有稀疏的特定标签，例如a、b、c以浅色字母显示在黑圈上，阅读代码示例会容易得多。除非你真的需要解释每一行，只为每一个交叉引用添加标记。Latex很好，但是有非常好的替代品。比如什么？我喜欢能够保持我的报告源在SVN，包括图形作为参考其他文件，并产生非常干净的PDF。+1所有好的建议。Wrt。在附录中编写代码：如果它都是可执行的，那就好了，但这通常是不切实际的。拥有一个独立的可读代码文档可以在不牺牲简洁性的情况下保持可执行性。