非常に多くの場合、コメントはタスクを遂行しませんが、単にボリュームを作成し、書かれたものをプロンプトなしで分解する必要があり、時には追加のプログラムファイルを参照し、開発速度に影響します。
トピック自体は、古いプログラムのいくつかを改善しなければならなかった後に書くことにしました。 特に、私がそれらを書いたとき、コメントを書くことに十分な注意を払わなかったという事実に直面し、その結果、4年が経ち、私の古いコードを分析するために余分な時間を費やして、熊手を踏みました。 したがって、このトピックは、コード内のコメントの重要性に焦点を当てるために生まれました。 結論が出されましたが、以下で共有します。
適切なコメントを使用すると、特定のコードでのみ作業でき、他の場所で答えを探すことはできません。彼らは、これらの質問に答えます。答えはこの場所では見つけることができません。
コードにコメントを書く際に守る必要があるいくつかのヒントを思い出すことにしました。
いくつかのヒント
0.各プログラマーの優先タスクは、 関連するコメントです。
1. 「あなたが住んでいる場所を知っている暴力的なサイコパスが同伴するかのようにコードを書いてください」 -McConnell、Steve
2.私たちは自分自身のためだけにコードにコメントします（他の人が理解できるように）。
3.明らかなことについてコメントする必要はありません。
4.コメントはコードを補足するものであり、言い換える必要はありません。
5.コードが、言語の基本で説明されている標準の関数、構成、またはクラスを使用する場合、時間を無駄にしないでください。この場合、正しくフォーマットされたコードのみが役立ちます。
6.コードの断片に関する解説、コメント付きのコードと同じインデントで記述する必要があります。
7.コメントで誰かと話をするのは多くの人の悪い習慣です。コメントは短く明確にする必要があります。
8.解説では、タスクを後で残すことができますが、何らかの理由で現時点では完了していません。 そのようなメモを別のファイルに保存することはお勧めしません。なぜなら、あなた以外に、どこで何が完了していないかを確認するために他の誰かがコードを操作できるからです。 おそらく、より適切なソリューションが見つかるでしょう。
9.グッドプラクティス-ファイルの冒頭で、その目的を簡単に説明します。
10.新しいクラスと機能-着信データの取得元と取得元、目的を説明することをお勧めします。
11.不要なコードのコメントを取り除くために、クラス、関数、オブジェクトなどの名前を選択できます。 予約制。
おわりに
その結果、私たちと同僚はコメントに余分な時間を費やすことはありません。 コードを逆アセンブルする人をいらいらさせることはありません。
また、膨大なコメントのファンの場合は、それらを別のドキュメントに置き換えることをお勧めします。
あなたの時間を節約し、あなたのコードで作業する人をspareしまないでください。
PSプログラマーの過去の休日に皆を祝福します、あなたの興味とあなたの仕事が一つであることを望みます。 クライアントが優秀であり、あらゆるビジネスが成功するように。