序章

コメントは、適切に配置されていれば、プログラミングで実際に非常に役立ちます。しかし、ほとんどの場合、コメントはそれほど「良い」ものではありません。

悪いコメントは、誤った情報につながり、時間を浪費し、悪い習慣を生み出す可能性があります。

この記事では、悪いコメントを書かないようにする方法をご案内します。

悪いコメント

古いコメント

古くなった、時代遅れになった、無関係な、または間違った情報を提供するコメント。コードベースは毎日変わる可能性があり、テクノロジーは毎日変わる可能性があるため、コメントはすぐに古くなる可能性があります。

の解き方：

• できるだけ早く更新する
• 実際に削除するだけです

間違った文法、あまりにも多くのマーカー、つぶやき、プロッピングは単に下手に書かれています。きれいなコードによれば、書く価値のあるコメントはよく書く価値があります。書く場合は時間をかけて磨き、慎重に言葉を選びましょう。

コメントアウトされたコード

これは最悪の種類のコメントです。コメント アウトされたコードのチャンクを見るたびに、気が狂いそうになります。そのコードは何もしませんでした。彼らはそこに座って腐敗しました。しかし、「誰かがそれを必要とするかもしれない」ため、いつ削除するかは誰にもわかりません。

それを解決する方法は？削除するだけです！今日、Git は非常に価値のあるものになり、誰かが本当に必要としている場合に見つけることができます

冗長なコメント

これらもひどいです、これを見てください：

for(let i = 0; i < 10; i++){
  a = b // assign a to b
}

// a function returns sum of a and b
function sum(a, b){ return a + b}

それらを削除するだけです。

うるさいコメント

一部のコメントはうるさいだけです。このようなコメントを見たことがありますか？

// the name
private String name
// the version
private String version
// the constructor
constructor()

//The 123213 License
//
//Copyright (c)123213213213213, and Contributors
//
//Permission to use, copy, modify, and/or distribute this software for any
//purpose with or without fee is hereby granted, provided that the above
//copyright notice and this permission notice appear in all copies.
//
//THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
//WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
//MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
//ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
//WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
//ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
//IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

HTML コメント

これについては何も言うことはありません。HTML コメントはまったく役に立たないと思います。ID、クラス名、タグ名、およびコードの意味を伝えるための何千もの方法があります。とにかくわざわざコメントを書くのはなぜですか？

結論

一部のコメントは実際には必要で有益ですが、ほとんどのコメントはそうではありません。この記事があまりポジティブではないことは承知していますが、それを正当化したいだけです。

コードが悪い場合は、コメントせずにクリーンアップするだけです

次の記事では、良いコメントの書き方について書いていきますので、フォローボタンを押してチェックしてみてください。

読んでくれてありがとう

最後の言葉

私のコンテンツは誰でも無料ですが、この記事が役に立ったら、ここでコーヒーを買ってください