順次加筆予定
コメントの減らし方
そもそもコメントを大量に書く必要がある場合は何かが間違っている可能性を疑う
- コメントのためのコメントは書かない
- 変数やメソッド名から内部処理がある程度推測できる名前を利用する
何をコメントとするか
ソースコードだけからでは推定が難しいものを対象とする
全体の実装方針
- 最初にソースコード全体の実装方針を記載する。
- 個別の関数やオブジェクトのコード実装が木に相当するなら全体の実装方針は森に相当する。最初にイメージが湧くと読みやすい。
入出力の具体例
- 具体的な入力値・出力値の例(処理のイメージが湧くため)