coding-style - 如何在研究报告中格式化代码

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题？更新问题，以便 editing this post 可以用事实和引用来回答它.

6年前关闭。




Improve this question




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

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

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

我与将向其提交报告的机构没有联系，他们也没有发布关于如何格式化代码的指南(请不要质疑这些点)。

Answer 1

这是我的偏好:

内联编写时，去掉与解释无关的代码(如import
前面提到的语句，但也可能是“显而易见”的变量声明等)。内联代码的目标应该是便于与描述该代码块的段落进行交叉引用。

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

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