記事のディレクトリ
良いコメント
コードの可読性と保守性のための豊富な注釈と良いコーディング標準は重要な役割を果たしています。ほぼすべての企業、これらの要件は、コーディング標準の独自のセットを形成する傾向がある、非常に厳しいです。しかし、実装プロセスでは、非効率的でなく、難しいことではありませんのみ行う手動のおかげで、真のコンプライアンスを確保する場合。IDE環境を組み合わせて、自動的にコメント、または必要に応じて生成します。この記事では、カスタムテンプレートのコードのコメントを作成するために使用Eclipseを説明しています。
第二に、良いコメントのルールに従う必要
- 良いコメントにはコメントはありません
让代码具有自解释
機能。 注释要精炼
ナンセンスではないですか、長すぎない、単に繰り返さないでください。提供信息
コメントは良いコメントです。いくつかのコメントはちょうどそれは、コードやその他の有用な情報の目的を示すものではありません、コードを変換します。TODO注释也是好注释
、プログラマに警告するためのコードのいくつかの部分が完了していません。- 以下のため
公共的API需要提供好的Javadoc
。 不要注释代码
。その後、コメントコードが人々に非常に重要な意味を与える、他の人が最後に意地の悪い多くのコメントが含まれているコードが生成されます、削除されません。不要万物皆注释
。- 後にコメントを書き込むに
时常更新
。
第三には、コメントのテンプレートを設定します
日食:ウィンドウ- > Preference-> Javaベース>コードSTYLE->コードテンプレート
アムウェイのいくつかの場所以下、より快適なコメントを追加します。
(1)(注クラス)タイプコメントタグ
/**
* 类说明:
*
* @guoqianliang1998.
*/
(方法を注釈付き)(2)メソッドコメントタグ
/**
* 方法说明:
*
*/