プログラム開発者がコードにコメントを添付することは非常に重要です。テクノロジーの開発により、プログラマーはプロジェクト開発中にコードコメントを作成する必要があります。これは、コードの後続の執筆と使用を助長するものです。
基本要件：
1。統一コメントフォーム
アプリケーション全体で、一貫した句読点と構造を持つスタイルを使用して、注釈を構築します。アノテーション仕様が他のプロジェクトでこのドキュメントとは異なることがわかった場合は、この仕様に従ってコードを記述し、確立された仕様システムに新しい仕様を導入しようとしません。
2。コメントコンテンツは正確で簡潔です
コンテンツはシンプルで明確で正確でなければならず、コメントの曖昧さから意味を防ぐ必要があります。誤ったコメントは役に立たないだけでなく、有害です。
3。基本的なコメント（追加する必要があります）
（a）クラスのコメント（インターフェイス）
（b）コンストラクターの解説
（c）方法に関するコメント
（d）グローバル変数のコメント
（e）フィールド/属性のメモ：単純なコードは簡単なコメントを作成します。コメントコンテンツは10語以下であり、さらにオブジェクトが永続的であるか、
VOオブジェクトのゲッターとセッターのメソッドにコメントする必要はありません。特定の注釈形式については、次の例を参照してください。
4。特別なコメントを追加する必要があります（追加する必要があります）
（a）典型的なアルゴリズムにコメントする必要があります。
（b）不明確なコードでコメントを作成する必要があります。
（c）コード変更の変更マークにコメントを追加します。
（d）ループと論理ブランチで構成されるコードのコメント。
（e）他の人に提供されるインターフェイスを詳細にコメントする必要があります。
注：このタイプのコメント形式の例はありません。特定の注釈形式は自分で定義されており、アノテーションコンテンツは正確かつ簡潔にする必要があります。
5。コメント形式：
1）シングルラインコメント：「// ...」
2）ブロックコメント：「/*…*/」
3）ドキュメントコメント：「/**…*/」
4）Javadocコメントタグ構文
@Authorクラスの説明は、クラスのモジュールを開発した著者を示しています
@versionクラスの説明は、クラスのモジュールのバージョンを示しています
@SEEリファレンスクラス、プロパティ、および方法の説明、つまり関連するトピックに頼る
@paramメソッドの説明メソッド内のパラメーターの説明
@returnメソッドの説明の説明メソッド返品値
メソッドの説明の説明@Exceptionメソッドによってスローされる可能性のある例外の説明
6。例：
/**アレイを操作するためのツールクラスを作成します。これには、アレイを動作させるためのこの共通関数が含まれています。 @Author Zhang San @バージョンv。 MAXを返します。 }}
下の図に示すようにコマンドを入力してください。
次に、次のディレクトリで確認し、最後にindex.htmlをクリックします。
上記のコンテンツは、Javaコードのコメント仕様をあなたと共有し、それがあなたに役立つことを願っています。