このページに書いてあること JavaDocには呼び出す側が知りたい契約を、コードコメントには実装を選んだ理由を残します。利用者IDから表示名を探す例で、書きすぎる場合、書かない場合、契約に絞る場合を比べます。 関連記事プログラミングのバグや無駄を減らすために意識してほしいこと4つ 定数とnullの扱い、結果を表すenum、コメントを置く場所を小さなコードで確認できます。 記事を読む → 最もやばいと思うJavaDoc=詳細設計書パターン 実装の各行を説明している当時のJavaDocです。利用者を探すという ...