comments - コーディング中のコメントと、最初にコーディングしてからコメントすることの賛否両論

Question

コードを書いている間にコードにコメントすることと、後ですべてのコメントを書くために戻ってくることのどちらに賛成し、反対する議論は何ですか? コードを書く前にコメントを書いてみませんか？

Answer 1

コーディング中にコメントを書くことは非常に重要だと思いますが、それでも後で戻って物事を明確にすることを妨げるものではありません。

コーディング中にコメントを書く

• あなたはおそらく戻って後でそれをすることはないでしょう。
• なぜ自分がしたことをしたのか覚えていないでしょう。
• 技術やアルゴリズムを研究する必要がある場合は、「情報源を引用する」ことをお勧めします。

コーディング後にコメントを書く

• おそらく、どの部分があまり明確ではないかについてより多くの洞察を得て、コードを新鮮な視点から見ることになります。

Answer 2

コメントの代わりに、変数、クラス、メソッドなどの非常にわかりやすい名前でコードを記述します。

ほとんどの場合、コメントではなく、コードの意図を文書化するテストを優先します。

コメントが書き込まれるとすぐに、「コードとの同期」の問題が発生します。

よくコメントしていました。現在、私はコメントを使用する場合でも非常に控えめに使用しています。もしそうなら、通常、明確でない異常なエッジケース、またはリファクタリングすべきではないように見えるが、かなりあいまいな理由でリファクタリングされるべきではないコードのためです。

Answer 3

これが削除される前に明白なことを述べる。

1. コードのチャンクの目的を忘れてください
2. 自己混乱

ループや関数の高度なアルゴリズムなどの複雑なコード他の開発者はコードを理解できません-後で使用するときに自分自身を含めてくださいまた、メモリ、パフォーマンスを向上させたいときに消費します。

Answer 4

その間。

コードを書いている 間は、コードのすべての行を最もよく理解できます。