Method Comment（メソッドのコメント） - Strategic Choice

師曰くコードから容易に読み取ることのできない情報を伝えるためにメソッドにコメントをつけなさい。どういうこと？「名前」と「コードの構造」で、できるだけ多くの情報を表現すべきです。コメントは「コードからははっきり伝わらない情報」を表現するために追加するようにします。この指針に従い、必要と思われる箇所で、メソッドやクラスの目的を説明するJavadocコメントを追加します。どうして？意図が伝わるように書かれたコードでは、多くのコメントが不必要な「重複」になっています。コメントを書くコスト、コメントとコードの一貫性を維持するコストに見合うだけの価値をもたらしていません。コードとコメントでDRY原則違反を犯しているのです。よって、コードで表現できない、そのコードがそうなっている「理由」をコメントに書くようにします。どうすれば？この実装パターンにおいては、コミュニケーションこそが最重要の価値です。メソッ

[H_Yamaguchi]

テストコードには「What」 ソースコードには「How」 ドキュメントには「Why」

[kakutani]

Kent Beckとオレと佐藤さんの名前が並んでる。すごくうれしい。