英语不是我的母语。但是,我必须用英文写评论。我想通过研究一段用好英语评论的代码来提高我的“评论英语”。请推荐一个开源项目,其中包含大量由精通语言的人撰写的有意义的评论。
7 回答
我不认为评论是一个学习的好地方,即使你必须效仿这种风格。评论通常甚至不是正确的英语,而且好的项目不会有太多评论,因此没有太多可学习的地方。
另一方面,如果您采用一个被广泛评论的项目,您几乎可以肯定它不是一个很好的榜样,因为程序员无法传达简洁的含义。当然,这是一个概括。但是,我相信它(几乎?)总是正确的。YMMV。
相反,通过学习专家来学习英语。有一个关于这个的问题。我推荐了威廉·辛瑟 (William Zinsser) 的《写得好》,我会再推荐一次。
(顺便说一句,英语也不是我的母语。)
我可以推荐 Simon Tatham 的拼图系列。
我读过的评论对我来说看起来像是正确的英语。此外,它们写得很清楚,并包含有用的信息,说明为什么事情会以它们的方式完成。
开发人员文档也易于阅读和理解,作为附带的好处,您将阅读具有良好且简单架构的系统的文档。
如果您的目标是阅读某些内容然后在没有明确理解为什么这样做是个好主意的情况下模仿它,我绝对可以推荐 ST 的谜题。如果你想清楚地了解什么是好的写作,我认为 ST 的谜题将是一个很好的例子,但你真的想阅读像 Strunk and White 这样的东西。
我只看过其中的一小部分,但我听说 linux 内核的评论非常好。
我一直认为Angband的评论很好。
我相当好评的开源项目是 Drupal 。在Drupal.org上查看。我在其中开发了几个门户网站,您实际上可以通过阅读模块和主题中的评论来学到很多东西。实际上,它们比文档提供的信息要多一些。
Minix的评论非常好。它们在某些地方可能有点简洁,但评论非常有帮助。
另外,如果你想提高你的写作水平……关于英语有很多令人困惑的事情。你如何掌握这些要点是平庸作家与优秀作家的区别。最好的、最小的和最简洁的书(每个人都应该有一本!)被Strunk 和 White 称为风格元素。请注意,您可以在亚马逊上以 2 美元的价格购买它。你会花的最好的 2 美元!