2人目または3人目のコメント？

Question

コメントは2人目か3人目ですか？

// go somewhere and do something (2nd person comment) 

または

// goes somewhere and does something (3rd person comment) 

Answer 1

確かに3人目のスタイル。

Answer 2

私は、多くの場合、医師のスタイルを話す傾向がある：

// Now we take $x and check whether it's valid for this pass 

Answer 3

役立つTipsを：できるだけ自己完結型として各コメントを維持しようとします。たとえば、このフォーム：

// First, mumble the frabbitz. 

blah blah 

// Second, foobar the quux 

blah blah 

これは素敵な物語ですが、「第一」および「第二」の部分が間違っになる可能性があるので、それは難しいコードを編集することができます。結局のところ、彼らはコメントにそれほど多くを追加するのではなく、それらを壊れやすい方法で相互関係させる。

Answer 4

私は時々この

/* 
Usage: 
set_position(0.5, 0.5); // im in the center 
set_position(0.0, 1.0); // im in the lower,left corner 
*/ 

Answer 5

ようですが、コードを編集し、どのような目的のためにされているどのように多くの人に依存してもよい、第一の人に話します。それにもかかわらず私自身のコードでは、おそらく「私」を使っていくつかの個人的なコメントを自由に追加することができます。共同プロジェクトでは、コメントは共同体的なスタイルを目指すべきであり、「私」は不在である可能性がある。

コメントは脆弱であり、現代の多くの当局（たとえば、コードのクリーン）は、機能やフィールドに意味のある名前を付ける必要があることに注意してください。しかし、言うまでもなく、説明的コメントが依然として重要な場所はたくさんあります。

Answer 6

私の見解では、あなたが最も快適に感じるスタイルを使用してください。

埋め込みコメントは、あなたとあなたのコードの実装の詳細を理解しようとする他の開発者が読むことを前提としています。彼らが明確かつ分かりやすい限り、スタイルが少し珍しい、文法が少し悪い、またはいくつかのスペルミスがあるかどうかは重要です。それを読んでいる人々は、そのようなことを気にすること以上にすべきである。

APIドキュメントを作成するために抽出されたコメントは、スタイル、文法、スペルの細部に少し注意を払う必要があります。しかし、ここでも精度と完全性ははるかに重要です。