[CleanCode]第4章コメント

3051 ワード
cleancode テキストリンク
悪いコードにコメントをつけないでください.再編成しましょう-ブライアン・W・コニハン、P・J・フラッグ
走りの良いコメントはどんな情報よりも役に立ちます.
  • 根拠のない注釈はコードを理解しにくい.
  • 古くて粗い注釈は虚偽と誤った情報を散布する.
  • 事実上、議長は必要です.プログラミング言語の表現力を高めれば,注釈は不要である.
  • 意図を表現していない失敗を挽回するために注釈を書きます.
  • 議長はいつも失敗を意味します.
  • コードで意図を表すたびに、自分を称賛します.
    • 注ぐたびに表現力がないと愚痴をこぼす.
  • から、注釈を必要としない方向にコードを記述する.
  • 真実はコードにのみ存在します.

    • 注記悪いコードを補うことはできません。


    注釈を追加する一般的な理由は、コードの品質が悪いことです.
    コメントを整理しますか?(X)→コードを整理!(O)

    コードで意図を表す!

    // ASIS
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))

// TOBE
if (employee.isEligibleForFullBenefit())

    よい議長


    最良または有益な注釈がある.
    法的コメント
    契約条件の法律情報、例えば
  • ソースファイルの先頭にある著作権/所有権.(IDE自動折りたたみ注釈タイトル)
    • 情報を提供するコメント
    // 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();
  • の戻り値を^関数名として明示的に表すことを推奨します.
    // kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");
  • 正規表現の説明*視点と日付を変換クラスに抽出することを推奨します.
    • 意図を説明する注釈
    注釈
    警告結果のコメント
    榔TODOコメント
    重要性を強調するコメント
    公開APIでJavaを使用する

    悪いコメント


    小言を言う
    重複するコメント
    誤解の可能性のあるコメント
    義務コメント
    履歴を記録するコメント
    コメントの有無
    恐ろしい騒音
    如果可以用‣函数或变量表示,就不要加注释
    かっこのコメント
    コメント
    榔注釈コード
    {HTMLコメント
    榍グローバル情報
    情報が多すぎる
    ファジイ関係
    ωǒ
    沬非公開コードのJavadocs
    例
    23日目-21.06.30
    asyncを解読して、C