3

チームメイトが書いたコードにコメントすることの重要性をどのように説明しますか？一時的なコメントを書くコーダーもいれば、期待されることがたくさん残っているコーダーもいますが、コメントを読むときに何を期待しますか？

4

9 に答える 9

3

いくつかの最小値があります：

  1. すべての関数とクラスにコメントを付ける必要があります
  2. 試行/キャッチおよび例外処理はコメントする方が良い
  3. コードにハードコーディングされた定数は間違いなく
  4. ダミーオブジェクトとダミークラス、およびTO-DOパーツにコメントを付ける必要があります
  5. URLからコードを取得する場合は、さらなる検討と著作権侵害の問題のために、コメントにそのアドレスを引用する必要があります
  6. また、バージョン管理システムへのコミットは十分にコメントする必要があります

コメントは最小限に抑える必要がありますが、明らかな場合はforループの定義にコメントする必要はありません。通常、プログラマーには基本ルールを設定します。明確に定義されている場合は、それに固執します。

于 2009-01-17T22:02:38.990 に答える
3

最高のコメントは、一言で言えば常に簡潔です。コードで明らかでないことを言う必要があります。私は多くの人々が次のような明白で役に立たないコメントをしているのを見ます：

if x==0 //if x equals 0 then...

まあ、本当に？！これはコードを「汚染」しているだけです。プログラミングの方法を学んでいない限り、それはかなり役に立たないからです。

コードがあなただけのものであっても、それをまったく知らない別のプログラマーと共有しようとしているかのようにコメントを書く必要があります。そうすれば、常にそれを理解できるようになり、長期的には誰かがやって来てそのコードを拾い上げれば、その人はそれを理解して拡張/使用できるようになります。

コメントは再利用性の向上だと思います。そして、他のすべてのプログラマーと同様に、単一の単純で簡潔なコメントでコードのブロックを完全に理解することを期待しています。

于 2009-01-17T22:09:35.073 に答える
2

直感的でないコードを書いているときにコメントを書いてください。配列を繰り返すだけのメソッドにコメントする理由は実際にはありませんが、バグを修正したり、問題を回避するために何かを一緒にハックしたりする必要がある場合は、コメントを付けて、6か月後にそのコードをすばやく理解できるようにすることをお勧めします（誤って元に戻さないでください）。

于 2009-01-17T22:02:41.390 に答える
2

コードにコメントするとはどういう意味ですか？実際のコード、または関数ヘッダー？

あなたが実際にコードについて話しているのなら、それは失われた原因です。あなたは彼らに読みやすいコードを書いてもらい、それを意味のあるチャンクに分割する必要があります。悪いコードにコメントしても、それは良いコードにはなりません。一貫性のない混乱を残すだけです。

ヘッダーのドキュメントについては、重要なこと（サプライズ、ディレクティブなど）をキャプチャし、些細なこと（すべてのパラメーターを一覧表示し、署名の機能を繰り返す）について妥協する必要があります。人々は、ほとんどの努力があなたの知性をほとんど侮辱する些細なテキストを書くことに費やされているので、文書化機能を嫌います（例えば、getHandleToFile（）で、「これはファイルへのハンドルを取得します」）。実際には、予想よりも重要性の低い詳細がはるかに少ないため、彼らは喜んで驚かれ、それらの特定の状況に努力を投資する可能性が高くなります。

于 2009-01-17T22:02:42.577 に答える
1

他の人がいつか従わなければならないかもしれないコードを書いているなら、物事が何をしているのかについて良いコメントを残すのが賢明だと思います。あなたが自分のために何かを書いているだけなら、最小限にするか、まったく残さない傾向が強いです。そうは言っても、私は8年前に書いたコードに戻らなければならないという「それほど贅沢ではない」ので、もう使用しない言語（クラスASP）で適切にコメントしていませんでした。 、もっとコメントを残しておけばよかった！

于 2009-01-17T22:03:17.130 に答える
1

私はほとんどのパブリックメソッドとクラスにコメントしようとしています。それらのコメントでは、メソッドの機能、パラメーターの意味、および該当する場合は出力がどうなるかを読むことができます。

メソッド内にコメントを入れることもありますが、そこでは自分が何をしているのかコメントしていませんが、なぜそのようにしているのですか。

于 2009-01-17T22:45:08.233 に答える
0

あなたが書いている言語が人間が読める言語でない場合、私は非常にきめ細かい方法と手順レベルのコメントを提案します。

作成している言語が人間が読める形式（C＃、VBなど）の場合は、メソッドレベルではある程度詳細なコメントを使用し、プロシージャレベルでは最小限のコメントを使用することをお勧めします。

于 2009-01-17T21:58:24.207 に答える
0
  • メソッドとクラスに関するドキュメント生成のコメントを含めます。
  • すべての行にコメントしないでください。
  • 期待されることをしている場合、またはそれがコードから明らかでない場合は、コメントでその理由を説明してください。
于 2009-01-17T22:03:09.143 に答える
0

コメントで行う最も重要なことは、真実を伝えることです。バグを調査して、「明白ではない」コードのセクションと、それが実行しているのとは逆のことを実行することになっているというコメントを見つけた回数。誰が勝ちますか？あなたが決める...

関連するメモとして、それが文書化しているセクションよりも長いコメントは通常長すぎます。

于 2009-01-17T22:03:36.287 に答える