Java における @param アノテーションと @see アノテーションの役割に関する簡単な説明

@ param
@ param タグは、メソッドまたはコンストラクターの単一パラメーター、またはクラス、インターフェイス、またはジェネリック メソッドの型パラメーターをアーカイブできます。 @param タグを使用する場合は、メソッドのパラメータごとに 1 つを使用する必要があります。各段落の最初の単語はパラメータ名として扱われ、残りの単語はその説明として扱われます:

@param max The maximum number of words to read.

型パラメータをアーカイブするときは、3802ab901462addbff3cbf14176fea44:

@param一e element type of this List

を追加する必要があります。ただし、型パラメータは、その意味が明らかであるため、通常、明示的なドキュメントを必要としません。

@see
@see タグは、他の Javadoc ドキュメントにリンクする相互参照を作成できます。このタグの後に任意の識別子を付けることができますが、完全修飾する必要があります。たとえば、通常はクラス メンバーに単純な名前を付けることができますが、メンバーがオーバーロードされたメソッドの場合は、各パラメーターの型を列挙してメソッドのオーバーロードされたバージョンを指定する必要があります。現在のパッケージ内のインターフェイスまたはクラスを指定するには非修飾名を使用できますが、他のパッケージ内の型を指定するには完全修飾名を使用する必要があります。メンバー名の前に # を使用して、型のメンバーを指定できます。以下はすべて有効な @ See タグの形式です:

@see #getName
 
@see Attr
 
@see com.magic.attr.Attr
 
@see com.magic.attr.Deck#DECK-SIZE
 
@see com.magic.attr.Attr#getName
 
@see com.magic.attr.Attr#Attr(String)
 
@see com.magic.attr.Attr#Attr(String，Object)
 
@see com.magic.attr
 
@see Attribute Specification
 
@see "The Java Developer's Almanac"

最初の形式は getName という名前のメソッドを参照します。これは、ドキュメント コメント自体と同じクラスまたはインターフェイス内、あるいはクラス内または周囲にあります。インターフェイスの場合、この構文はコンストラクターとフィールドにも適用できます。 2 番目の形式は、現在のパッケージ内のクラス、またはインポートされたパッケージ内のクラスを参照します。 3 番目の形式は、完全修飾名を使用してクラスを参照します。

@see の最後の 4 つの形式はメンバーを参照しており、そのうち最初の 2 つはドメイン (DECK-SIZ) とメソッド (getName) に関するものです。メソッド名のみが定義されているため、メソッド名を直接使用できます。 Attr クラス getName メソッド。後の 2 つの形式は Attr クラスのコンストラクターを参照します。一方のコンストラクターは文字列引数を受け取り、もう一方のコンストラクターは文字列とオブジェクトを受け取ります。バージョンをロードするときは、引数を指定する必要があります。次の @see フォームは、特定のパッケージに誘導します: 最後の 2 つのフォームでは、引用符を使用して他のドキュメントを参照できます。これら 2 つの形式を使用して、エンティティに名前を付ける @see 形式 (上記の最後の 2 つの形式を除くすべての形式) の後にラベル (ラベル) を続けることができます。例:

@ see #getNameAttribute Names

は、 getName のドキュメントへのリンクを作成しますが、表示されるテキストは「属性名」です。通常はメンバーの実際の名前を使用する必要がありますが、ここに示すように、機能が役立つ場合があります。

Java における @param アノテーションと @see アノテーションの役割に関する詳細については、PHP を参照してください。中国語のウェブサイト