@param
@paramタグは、メソッドまたはコンストラクターの単一のパラメーター、またはアーカイブクラス、インターフェイス、および汎用メソッドのタイプパラメーターをアーカイブできます。 @Paramタグを使用する場合、メソッドの各パラメーターのタグの1つを使用する必要があります。各段落の最初の単語はパラメーター名と見なされますが、残りはその説明と見なされます。
@param max読むべき単語の最大数。
タイプのパラメーターをアーカイブする場合、型パラメーター名の両側に<and>を追加する必要があります。
@param体中国中国中国中国
ただし、タイプパラメーターは通常、明示的なドキュメントを必要としません。これらはすべて非常に明白であるためです。
@ 見る
@seeタグは、他のJavadocドキュメントにリンクされた相互参照を作成できます。タグを完全に資格を付ける必要がありますが、任意の識別子に名前を付けることができます。たとえば、通常、クラスのメンバーの単純な名前で名前を付けることができますが、メンバーがオーバーロードされた方法の場合、各パラメーターのタイプを列挙することにより、メソッドの過負荷バージョンを指定する必要があります。資格のない名前を使用して現在のパッケージ内のインターフェイスまたはクラスを指定できますが、完全に適格な名前を使用して他のパッケージのタイプを指定する必要があります。メンバー名の前に#を使用して、タイプのメンバーを指定できます。ここにすべて有効な @タグ形式を参照してください:
@see #getname @see artion @see com.magic.attr.attr @see com.magic.attr.deck#deck.ttr.attr#getname @see com.magic.attr.attrオブジェクト)@see com.magic.attr @see属性仕様@see "The Java Developer's Almanac"
最初のフォームは、ドキュメントアノテーション自体と同じクラスまたはインターフェイス、または特定の周囲のクラスまたは周囲のインターフェイスにあるGetNameというメソッドを指します。このような構文は、コンストラクターとフィールドにも適用できます。 2番目のフォームは、現在のパッケージのクラスまたは特定のガイドパッケージのクラスを指します。 3番目のフォームは、完全に適格な名前を使用したクラスを指します。
@Seeeの最後の4つのフォームはメンバーを参照します。最初の2つはドメインに関するものです(Deck-Siz Day and Method(getName)。1つのgetNameメソッドのみがattrクラスで定義されるため、メソッド名を直接使用できます。参照したい。
次の@seeフォームは、読者を特定のパッケージに導きます:com.magic.attro
最後の2つのフォームにより、他のドキュメントを引用することができます。その中で、前のものはリンクを定義するために使用し、後者は引用符を使用してドキュメント名を囲みます。両方のフォームを使用して、完全なマニュアルなど、他のドキュメントに読者を誘導できます。
言語エンティティに名前を付ける@seeフォーム(上記の最後の2つのフォームを除くすべてのフォーム)には、ラベルが続くことができます。生成されたドキュメントでは、このラベル名はエンティティの名前を置き換えます。例えば:
@ #getnameattribute namesを参照してください
GetNameのドキュメントへのリンクが作成されますが、表示するテキストは「getName」ではなく「属性名」です。通常、メンバーの本名を使用する必要がありますが、ここに示す機能は時々役立ちます。