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

Question

API でない限り、コードにコメントを付ける必要があると思いますか?

つまり、良いコードです。自明の変数とメソッドを使用。

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

ありがとう。

Answer 1

良い質問ですが、非常に主観的でもあります。非常に堅実なコードを記述し、適切に設計されたアプリケーションを使用している場合、そのほとんどすべての部分が自明です（自己文書化）。ただし、コメントを却下する前に、それが本当に当てはまるかどうかを自問してください。

とは言うものの、良いコメントは、コード、パッケージ、クラスのより大きな意図を明らかにすることがよくあります。ほんの数行を「説明」するのではなく、あなたがしていることのより高いレベルの概要を提供します。そしてもちろん、理解しにくいコード（複雑なアルゴリズム）についてコメントすることは有用です。

とにかく、それが私的使用のためだけであり、プロジェクトの範囲が限られている場合は、コードにコメントを散らかす必要はありません。明確にする必要があると思うときに、直感的にコメントを配置するだけです。後でコードの一部に戻ってそれを変更しなければならないときに、あなたがやったことを喜ぶことがよくあります。