请推荐一个具有良好英语质量评论的开源项目

Question

英语不是我的母语。但是，我必须用英文写评论。我想通过研究一段用英语评论的代码来改进我的“评论英语”。请推荐一个开源项目，其中包含很多有意义的评论，由具有良好语言能力的人员编写。

Answer 1

我不认为评论是一个学习的好地方，即使你必须模仿这种风格。评论往往不是正确的英语和好的项目无论如何也不会有太多的评论，因此，没有太多的东西需要学习。

另一方面，如果你采用一个被广泛评论的项目，你几乎可以肯定它不是一个伟大的榜样，因为程序员无法传达简洁的含义。当然，这是一种概括。但是，我相信它（几乎？）总是如此。 YMMV。

相反，通过研究专家来学习英语。关于此问题已经a question了。我建议“On Writing Well” by William Zinsser，我会再次这样做。

（顺便说一下，英语也不是我的母语。）

Answer 2

我可以推荐Simon Tatham的Puzzle Collection。

我读过的评论看起来对我来说是正确的英语。此外，它们写得很清楚，并包含有关为什么事情按原样完成的有用信息。

开发人员文档也易于阅读和理解，作为附带好处，您将阅读具有良好和简单架构的系统文档。

如果您的目的是阅读某些东西，然后在没有明确理解为什么这样做是个好主意的情况下模仿它，我绝对可以推荐ST的谜题。如果你想明确了解好的写作是什么，我认为ST的谜题将作为一个好的例子，但你真的想读一些像Strunk和White的东西。

Answer 3

我只看过它的一小部分，但我听说linux内核的评论非常好。

Answer 4

我一直认为Angband评论很好。

Answer 5

我相当好评论开源项目是Drupal。在Drupal.org处查看。我已经开发了几个门户网站，您可以通过阅读模块和主题中的注释来学习相当多的东西。实际上它们比文档更有用。

Answer 6

Minix评论很好。在某些地方，它们可能有点简洁，但评论非常有帮助。

Answer 7

另外，如果你想提高你的写作......英语有很多令人困惑的事情。你如何掌握这些观点是一个平庸的作家与优秀作家之间的区别。要获得的最好，最小，最简洁的书（每个人都应该有副本！）称为Elements of Style by Strunk and White。请注意，您可以在亚马逊上获得2美元。最好花2美元！