编码风格 – 如何在研究报告中格式化代码

我目前正在撰写正式的研究报告,我将在此报告中包含代码.

问题:是否有可接受的方式在研究报告中显示代码?我在考虑字体,间距等问题,以及代码是应该在文档内部还是在附录中显示.

代码将是JavaScript和PHP.代码的所有部分都不会超过25行(因此它们仅仅是片段).将有大约六个片段.每个片段都有几个段落,解释代码中发生的事情,并讨论其优缺点.

我没有与提交报告的机构联系,也没有关于如何格式化代码的公布指南(请不要质疑这些要点).

那么这取决于你的论文写入哪种风格指南以符合……

通常代码应该以单色字体编写,以便易于阅读(例如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

相关文章
相关标签/搜索