英語は私の母国語ではありません。ただし、コメントは英語で書かなければなりません。良い英語でコメントされたコードを勉強して、「コメント英語」を改善したいです。優れた言語能力を持つ人々によって書かれた意味のあるコメントがたくさん含まれているオープン ソース プロジェクトを推薦してください。
7 に答える
このスタイルをエミュレートする必要があるとしても、コメントは学ぶのに良い場所ではないと思います。コメントは英語でさえ正しくないことが多く、優れたプロジェクトではとにかくコメントが多すぎないため、学ぶことはあまりありません。
一方、広範囲にコメントされているプロジェクトを取り上げる場合、プログラマーは簡潔な意味を伝えることができなかったため、それは優れたロールモデルではないことはほぼ間違いありません。もちろん、これは一般化です。しかし、私はそれが(ほぼ?)常に真実であると信じています。YMMV。
代わりに、専門家を勉強して英語を学びましょう。これについて質問がありました。ウィリアム・ジンサーの「On Writing Well」をお勧めしましたが、またそうします。
(ちなみに、英語も私の母国語ではありません。)
サイモン テイサムのパズル コレクションをお勧めします。
私が読んだコメントは、私には正しい英語のように見えます。また、それらは明確に書かれており、物事がそのように行われる理由についての有用な情報を含んでいます.
開発者向けドキュメントも読みやすく理解しやすいので、副次的な利点として、優れたシンプルなアーキテクチャのシステムのドキュメントを読むことができます。
何かを読んでエミュレートしようとしても、それが良いアイデアである理由を明確に理解していない場合は、間違いなく ST のパズルをお勧めします。優れた文章とは何かを明確に理解したい場合は、ST のパズルが良い例になると思いますが、実際には Strunk and White のようなものを読みたいと考えています。
私はいつもAngbandがよくコメントされていると思っていました。
私はかなりよくコメントしたオープンソースプロジェクトはDrupalです。Drupal.orgで確認してください。私はその中にいくつかのポータルを開発しました、そしてあなたはモジュールとテーマのコメントを読むことによって実際にかなり学ぶことができます。実際には、ドキュメントよりも情報量が多い場合があります。
私はほんの一部しか見たことがありませんが、Linux カーネルは非常によくコメントされていると聞いています。
Minixは非常によくコメントされています。いくつかの場所では少し簡潔かもしれませんが、コメントは非常に役に立ちます。
また、ライティングを改善したい場合は... 英語については、混乱することがたくさんあります。これらのポイントをどのように習得するかによって、凡庸な作家と優れた作家が区別されます。入手するのに最適で、最小で、最も簡潔な本 (誰もがコピーを持っている必要があります!) は、Strunk and White による Elements of Styleと呼ばれています。Amazonで2ドルで入手できることに注意してください。あなたが使う最高の$ 2!