コメントを書くべきですか?

コードへのコメントと正しい方法でのコメントについての考え

コメントは非常に重要だとよく言われます。コメントはプログラミングの重要な部分です。初心者として、追加するコメントの数とコメントの書き方を判断して決定するのは困難です。

それは石に固定されていないことの1つであり、誰もが異なった対照的な意見を持っているように思われるので、これはあなたを不安に満ちた辺獄に残します。

これが私の考え方です。あなたはあなたの決定を説明するために、できるだけ少ないコメントを書くべきです

これを分析しましょう。

コードは、できる限り自明である必要があります。

JavaScriptやPythonのような高級言語は非常に読みやすいです。変数とメソッドに正しく名前を付ければ、ほとんど声を出してコードを読み、それが平易な英語であると考えることができます。

いくつかのことはもう少し考える必要がありますが、コードが少し複雑であっても、プログラマーがそれを読んでコードの機能を100%判断できる限り、コメントは必要ありません。

説明する必要がある場合はコメントが必要ですなぜ特定の命令またはブロックの。ではありません、それはコードから推測されるべきです。私たちはそれを高レベルと呼んでいます。それは私たちが考えることができるコードです。読みやすく理解しにくい機械言語やアセンブリではありません。

コードの一部のブロックには、他のブロックを説明するためのコメントが必要です。あなた自身でさえなぜあなたは特定のことをしています。もちろん、必ずしもそうとは限りません。

6か月経っても、コードベースの別の部分で作業してからそのコード行に戻った場合、編集時に問題になっていたすべてのことを覚えていない可能性があります。何かを追加した理由の90%を思い出すかもしれませんが、他に見つけられないことがありました。コメントはそのために素晴らしいでしょう。

コードは単なる指示やコメントではありません。多くの場合、ソース管理のおかげでコード行が追加された理由がわかります(ギット)。 Gitアプリでラインナップを確認すると、そのラインの履歴から、あなたや同僚が10か月前に編集した理由がわかります。 「バグを修正する」ではなく、Gitコミットメッセージが有用で詳細な場合。これは優れたドキュメントでもあり、特に多くの人がコードベースに触れる可能性のあるオープンソースプロジェクトに適しています。

就職の面接で、「演習にコメントを追加する必要がありますか?」と自問する場合。答えは常にですはい

彼らはおそらくあなたのコメントとあなたのコードについてあなたを判断しますか?そして、あなたがコメントに書いたことも。

私は確かにそれをします。あなたがいくらコードウィザードになっても、会社は3か月以内にあなたを解雇する必要があり、次にあなたを置き換える人はあなたのコードを理解する必要があります。それは会社の資産だからです。彼らは、ソースコードを読み込もうとしている他の人々に共感することをいとわない、またはできない誰かを雇う余裕はありません。