-
- 既知のすべてのサブインタフェース:
ParamTag
,SeeTag
,SerialFieldTag
,ThrowsTag
@Deprecated public interface Tag
非推奨。このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。単純なドキュメンテーション・タグ(@since、@author、@versionなど)を表します。 各タグ(@since 1.2など)は、タグ名(@sinceなど)とタグ・テキスト(1.2など)を保持します。 構造を持つタグや特殊な処理が必要なタグは、ParamTag (@paramの場合)、SeeTag (@seeと)、ThrowsTag (@throwsのために)などのサブクラスで処理されます。- 関連項目:
SeeTag
,ParamTag
,ThrowsTag
,SerialFieldTag
,Doc.tags()
-
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 抽象メソッド 非推奨のメソッド 修飾子と型 メソッド 説明 Tag[]
firstSentenceTags()
非推奨。コメントの最初の文をタグの配列として返します。Doc
holder()
非推奨。このタグ要素のDoc
を含めて返します。Tag[]
inlineTags()
非推奨。埋め込まれた{@link}
タグのあるドキュメンテーション・コメントの場合、Tag
オブジェクトの配列を返します。String
kind()
非推奨。このタグの種類を返します。String
name()
非推奨。このタグの名前を返します。SourcePosition
position()
非推奨。このタグのソース位置を返します。String
text()
非推奨。このタグのテキスト(タグ名よりも後ろの部分)を返します。String
toString()
非推奨。このオブジェクトを文字列に変換します。
-
-
-
メソッドの詳細
-
name
String name()
非推奨。このタグの名前を返します。 名前は、@return
のように、ドキュメンテーション・コメントで使用される@で始まる文字列です。{@link}
のようなインライン・タグの場合、中括弧は名前には含めず、この例では、単に@link
がこのインライン・タグの名前になります。- 戻り値:
- このタグの名前
-
kind
String kind()
非推奨。このタグの種類を返します。 ほとんどのタグでは、kind() == name()
です。指定された種類のタグが複数ある場合を次の表に示します。関連タグ name()
kind()
@exception
@throws
@link
@see
@linkplain
@see
@see
@see
@serial
@serial
@serialData
@serial
@throws
@throws
- 戻り値:
- このタグの種類。
-
text
String text()
非推奨。このタグのテキスト(タグ名よりも後ろの部分)を返します。- 戻り値:
- このタグのテキスト。
-
toString
String toString()
非推奨。このオブジェクトを文字列に変換します。
-
inlineTags
Tag[] inlineTags()
非推奨。埋め込まれた{@link}
タグのあるドキュメンテーション・コメントの場合、Tag
オブジェクトの配列を返します。 ドキュメンテーション・コメント全体が、{@link}
タグで分割された複数の文字列に分けられます。この場合、配列の連続する各要素は、最初から最後まで順番に特定の文字列または{@link}
タグを表します。 各文字列は、Textという名前のTag
オブジェクトで表されます。この場合、text()
は文字列を返します。 各{@link}
タグは、名前が@linkで種類が@seeのSeeTag
によって表されます。 たとえば、次のコメント・タグが指定されたとします。This is a {@link Doc commentlabel} example.
次のTagオブジェクトの配列を返します。
-
firstSentenceTags
Tag[] firstSentenceTags()
非推奨。コメントの最初の文をタグの配列として返します。 インライン・タグ({@link reference}タグ)を含みますが、ブロック・タグは含みません。 プレーン・テキストの各セクションは、種類TextのTag
として表されます。 インライン・タグは、種類@linkのSeeTag
として表されます。 ロケールが英語の場合、最初の文はJava言語仕様(最初のバージョン)に記述されている規則によって決定されます。"この文は、直後にスペース、タブ、または改行が続く最初のピリオド、または最初のタグ・ラインで終了します。"さらに、行は段落およびセクションの終わりを示す、次のようなHTMLタグで終了します。<p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>または</pre>。 ロケールの言語が英語でない場合、文の終わりはBreakIterator.getSentenceInstance(Locale)
によって決定されます。- 戻り値:
- コメントの最初の文を表す
Tag
オブジェクトの配列
-
position
SourcePosition position()
非推奨。このタグのソース位置を返します。- 戻り値:
- このタグのソース位置。
-
-