コメントコードAS3 - APIではない

Question

APIがない限り、コードにコメントする必要があると思いますか？

私は良いコードを意味します。自己説明変数と方法を用いて。

良いコードをコメントする必要がありますか？

ありがとうございました。

Answer 1

これは良い質問ですが、非常に主観的です。非常にしっかりとしたコードを書いていて、うまく設計されたアプリケーションを持っているならば、ほとんどすべての部分は自己説明的です（自己文書化する）。しかし、あなたがコメントを却下する前にそれが本当に起こっているかどうか、あなた自身に尋ねてください。

しかし、良いコメントは、しばしばコード、パッケージ、クラスの断片の意図を明確にします。彼らはあなたが何をしているのかについてより高いレベルの概要を提供します。もちろん、複雑なコード（複雑なアルゴリズム）を理解するのは難しいです。

とにかく、私的使用のためのものであり、プロジェクトの範囲が限られている場合は、コードをコメントで捨てる必要はありません。後でコードに戻って変更する必要がある場合は、しばしばうれしいでしょう。