typescriptで本の例を書きました.意味が一致しないかもしれませんが、できるだけ似たような感じで書きます.🥺

1.なるべくコメントを書かない

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

コードにコメントを追加する一般的な理由はコード品質の悪さ

自己による混乱(👀)注釈で説明しないで、時間をかけて改善しなければなりません.

コードは意図を表すこともできる.

ex)

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

// 의미있는 이름을 지으면 해결된다.
if ((employee.isEligibleForFullBenefits()) {} 
// -> 별도의 함수로 만들고 boolean값으로 리턴

議長は見送られた。

コードの変更が追いつかず、コメントは見送られた.

コードはコンパイルされて呼び出されるが、コメントはコメントのみであるため、その場に置かれ、最終的には無意味なテキストとなる.

2.良いコメント

実施情報提供

意図と重要性を説明

TODO・FIXME議長

3. JsDoc

Javadoc類似

JavaScript APIドキュメントジェネレータ