Javaコードコメント仕様の詳細説明（パワーノード構成）

コードコメントは、プログラム設計者とプログラム読者の間のコミュニケーションの橋渡しとして機能し、チーム開発の協力効率を最大化します。これは、プログラム コードの保守性の重要な側面の 1 つでもあります。この記事では、私たちが日常の開発で使用するコード コメントの仕様についてお話しましょう

コード コメントは、プログラム設計者とプログラム読者の間のコミュニケーションの架け橋となり、チーム開発の協力効率を最大化します。これは、プログラム コードの保守性の重要な側面の 1 つでもあります。したがって、コメントを書くためにコメントを書くわけではありません。参考までに、私たちが日々の開発で使用しているコードコメントの仕様についてお話します。

1. 統一されたコメントフォーム

アプリケーション全体で一貫した句読点と構造を持つスタイルを使用してコメントを作成します。 他のプロジェクトのアノテーション仕様がこのドキュメントと異なることに気付いた場合は、この仕様に従ってコードを記述し、確立された仕様体系に新しい仕様を導入しようとしないでください。

2. 注釈の内容は正確かつ簡潔である必要があります

注釈のあいまいさを防ぐために、内容は単純かつ明確であり、意味が正確である必要があります。

アノテーションの条件:

1. 基本的なアノテーション

(a) クラス(インターフェース)のアノテーション

(b) コンストラクターのアノテーション

(c) メソッド

のアノテーション

( d) グローバル

変数

に関するコメント(e) フィールド/

プロパティ

に関するコメント 注: 単純なコードに対しては単純なコメントを作成し、コメント内容は 10 ワードを超えてはなりません。また、

オブジェクト を永続化してください。 VO オブジェクトの getter メソッドと setter メソッドには注釈を付ける必要はありません。具体的なコメント形式については、以下の例を参照してください。

2. 特別なコメントが必要です

(a) 一般的なアルゴリズムにはコメントが必要です。

(b) コードが不明瞭なコメントがあるはずです。

(c) コード修正に修正を示すコメントを追加します。

(d)

ループと論理分岐で構成されるコードにコメントを追加します。

(e) 他の人に提供されるインターフェースは詳細にコメントする必要があります。

注: このタイプのコメント形式の例はまだありません。注釈の具体的な形式は自分で定義し、注釈の内容は正確かつ簡潔である必要があります。

コメント形式:

1. 単一行コメント: “//……”

2. ブロックコメント: “/*&*/”

3、ドキュメントコメント: "/ **&*/"

4. Javadoc コメントタグ構文

@author クラスの説明は、このタイプのモジュールを開発した作成者を示します

@version クラスの説明は、モジュールのバージョンを示します类@SEE の参照ステアリング用のクラス、属性、メソッドの説明、つまり関連トピック
@Param のメソッド内のパラメータのメソッドの説明@
Result
メソッド return のメソッドの戻り値の説明value@
@@@@@
例外 メソッドによってスローされる可能性のある例外を記述します

参考例:

1. クラス(インターフェース)のアノテーション

例:

/**
* 类的描述
* @author Administrator
* @Time 2016-11-14:49:01
*
*/
public classTest extends Button {
 ……
}

2. コンストラクターメソッドアノテーション

例:

public class Test extends Button {
 /**
 * 构造方法 的描述
 * @param name
 * 按钮的上显示的文字
 */
 public Test(String name){
 ……
 }
}

3. メソッドアノテーション

例:

public class Test extends Button {
 /**
 * 为按钮添加颜色
 *@param color
  按钮的颜色
*@return
*@exception (方法有异常的话加)
* @author Administrator
* @Time2012-11-20 15:02:29
 */
 public voidaddColor(String color){
 ……
 }
}

4. グローバル変数アノテーション

例: reee

5. /attribute annotation

例:

public final class String
 implements Java.io.Serializable, Comparable<String>,CharSequence
{
 /** The value is used for characterstorage. */
 private final char value[];
 /** The offset is the first index of thestorage that is used. */
 private final int offset;
 /** The count is the number of charactersin the String. */
 private final int count;
 /** Cache the hash code for the string */
private int hash; // Default to 0
……
}

実は基準は自分で決めたもので、チーム全員がそれを守って統一すれば良い結果が得られると思います。通常はコメントしません。

以上がJavaコードコメント仕様の詳細説明（パワーノード構成）の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。