質の高いコメントが英語で書かれたオープンソースプロジェクトをお勧めします

Question

英語は私の母国語ではありません。ただし、コメントは英語で書く必要があります。 「コメントの英語」を改善したい良い英語でコメントされているコードを勉強することによって。言語の優れた能力を持つ人々によって書かれた多くの意味のあるコメントを含むオープンソースプロジェクトをお勧めします。

Answer 1

サイモンタサムのパズルコレクションをお勧めします。

読んだコメントは正しい英語のように見えます。また、それらは明確に書かれており、物事がそのように行われる理由に関する有用な情報が含まれています。

開発者向けドキュメントは読みやすく、理解しやすく、副次的な利点として、優れたシンプルなアーキテクチャを備えたシステムのドキュメントを読むことができます。

何かを読んで、なぜそれが良いアイデアであるかを明確に理解せずにエミュレートすることを目指すなら、私は間違いなくSTのパズルをお勧めします。良い文章が何であるかを明確に理解したい場合、STのパズルは良い例として役立つと思いますが、実際にはStrunkとWhiteのようなものを読みたいです。

Answer 2

コメントは、このスタイルをエミュレートする必要がある場合でも、学ぶのに適した場所ではないと思います。コメントはしばしば正しい英語でさえありません、そして、とにかく良いプロジェクトはあまり多くのコメントを持たないので、学ぶことはあまりありません。

一方で、広範にコメントされているプロジェクトを取り上げた場合、プログラマは簡潔な意味を伝えることができなかったので、それが素晴らしいロールモデルではないことはほぼ確実です。もちろんこれは一般化です。しかし、私はそれが（ほとんど？）常に真実だと信じています。 YMMV。

代わりに、専門家を勉強して英語を学びます。これについては質問があります。 ＆＃8220; Well Writing Well＆＃8221;をお勧めします。 William Zinsserによって、またそうします。

（ちなみに、英語も私の母国語ではありません。）

Answer 3

私はこれまでほんの少ししか見ていないが、Linuxカーネルは非常によくコメントされていると聞いている。

Answer 4

Angband はよくコメントされているといつも思っていました。

Answer 5

オープンソースプロジェクトはDrupalであるとかなりよくコメントしました。 Drupal.org で確認してください。私はいくつかのポータルを開発しましたが、実際にはモジュールとテーマのコメントを読むことでかなり学ぶことができます。実際、それらはドキュメントよりも何倍か有益です。

Answer 6

Minix は非常によくコメントされています。一部の場所では少し簡潔になりますが、コメントは非常に役立ちます。

Answer 7

また、あなたの文章を改善したい場合...英語には混乱を招くものがたくさんあります。これらのポイントをマスターする方法は、平凡な作家と優秀な作家を区別するものです。入手するのに最適で、最も小さく、最も簡潔な本（誰もがコピーを持っていなければなりません！）は、 StrunkとWhiteによるスタイルの要素。 Amazonで2ドルで入手できることに注意してください。あなたが使う最高の$ 2！