-1

私は何年にもわたって学校を卒業し、業界で働いてきたので、コメントについて人々にアドバイスを求めることがよくありました. 悲しいことに、私たち全員が知っているように、多くの開発者とコメントすることは、補足的なものであり、それ以外のことではありません. そうは言っても、私は通常、かなり一般的な答えを得ます。実際、時間が経つにつれて何が本当に役立つかを確認するのに、これはあまり役に立ちません。

では、Visual Studio を使用して C# を構築し、コメントを作成する最良の方法は何だと思いますか?

4

4 に答える 4

9

少なくとも、トリプル スラッシュの XML コメント ブロックを使用して、パブリック API のすべての部分にコメントを付けます。これにより、必要なときにドキュメントを簡単に自動生成できます。

さらに、6 か月以内に解読するのが難しい特定のアルゴリズムやコードについてコメントします。コメントに対するこの「利己的な」アプローチ (つまり、後でこのコードを保守する必要があると仮定する) は、多くの場合、やり過ぎのない豊富なドキュメントの最適なバランスにつながります。

于 2008-10-09T17:29:47.050 に答える
3

コメントを書くときは、いくつかの基本的なガイドラインに従うようにしています。

  • コメントはシンプルに
  • コメントは明確にする必要があります
  • 実装を書く前にドキュメントを書く
  • 何をしているのかではなく、なぜそれをしているのかを文書化します。
  • インターフェイス、メソッド、プロパティ、およびクラスに組み込みの (XML スタイルの) コメントを使用します。
  • すべてのファイル (Something.cs など) の先頭に、ファイル名、説明、開発履歴、および著作権情報を含む概要を提供します。
  • バグ修正のコメントを追加します (該当する場合はバグ番号を添えて)
  • //TODO //BUG や //BUGFIX などの便利なアノテーションを利用する
  • 使用する予定がない限り、コードをコメントアウトしないでください
  • 行末ではなく、適用するコード行の上にコメントを追加します
  • コメントは 1 行に制限するようにしてください
  • 複数行のコメントには、/* */ の代わりに // を使用します
  • 「foo」、「bar」などは使用しないでください。
  • 必要に応じて大文字と小文字の規則に従います (キャメル ケーシングとパスカル ケーシング)。
于 2008-10-09T17:50:15.060 に答える
1

「たくさん、そして頻繁に」 -- ホビットのビルボ。

もっと真剣に、明らかでないことをコメントして、コードの目的が何であるか、そしておそらくそれを選んだ理由を読者に伝えてください。

それは言語によって変わるわけではありません。

于 2008-10-09T17:20:17.210 に答える
0

個人的には、より複雑なセクションでは、トリプル スラッシュ、SandCastle XML コメント、およびインライン コメントを組み合わせて使用​​します。頻繁にコメントしますが、簡潔にしてください。何かが何をするかを理解する前に、綿毛の連なりを読む必要はありません:-)

于 2008-10-09T18:17:39.920 に答える