什么是呈现源代码的最佳方式,包括离线和在书中?

这并不能完全回答大多数问题,但你可能有兴趣阅读 Literate Programming . 它的要点是,您将代码和文档写在同一个文档中,并且将其格式化为Web或打印或其他任何格式。当我在这里说文档时,它通常不是文档的一行代码片段,而是描述程序中发生的事情的整个段落或页面。

好吧,让我添加我对比例字体的投票,就像在tc++pl中使用的一样。这真的让我抓狂了!同样的,索克特·迈耶斯在《有效的STL》中也加入了一些令人讨厌的高调的恐怖。

对我来说,经典的编程书籍将永远是K&R,因为我认为它没有得到任何改进,以使演示更加清晰。所以我建议你还是随便复制一下。

我喜欢在文本中编写伪代码时使用扩展字符集。这个 乳胶 用于代码和数学标记的字体工作良好。

一个很好的例子是使用左箭头进行赋值或绑定,而不是 = . 我在书中看到的代码最好的例子是像龙书或淘宝。我认为数学语源学的混合,由于能够呈现这些字符,以及与公共语法的关系是伟大的。

一个通常固定的信使类型字体和先进的数学标记的混合物,可通过计算机在乳胶现代,我认为很好地为读者的数学配置…它看起来非常漂亮。

只是我脑海中闪过的几件事:

• 将行数限制为最小值
• 仅在需要时提供行号
• 你当然可以使用不同的字体,但是不同的背景呢?像浅灰色?把你的代码装箱,我认为把两个箱子放在一起没问题。
• 取决于成本,但是像大多数IDE一样,给某些元素上色怎么办?
• 写工作,现实世界的代码!因此,我建议使用普通的//注释样式,而不仅仅是其他字体。

• 我会使用一种单面字体 康索拉斯。
• 由于注释通常显示为不同的颜色(至少在我见过的IDES中),所以我会将它们保留原样。
• 你所说的“显示块之间的关系”是什么意思?指示函数、if语句等的开始和结束位置?如果是这样的话,可能会有所帮助;我真的不知道。
• 如果您比较几个代码块来表示一些细微的差异,这些差异在一个代码块中不起作用,而在另一个代码块中起作用,那么它可能会起作用,但除此之外,我看不出有什么用处。
• 如果您引用“在前一个代码示例中转到第XYZ行”,行号可能会有所帮助。