public interface Tag
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()
このオブジェクトを文字列に変換します。
|
String name()
@return
のように、ドキュメンテーション・コメントで使用される「@」で始まる文字列です。{@link}
のようなインライン・タグの場合、中括弧は名前には含めず、この例では、単に@link
がこのインライン・タグの名前になります。String kind()
kind() == name()
です。指定された種類のタグが複数ある場合を次の表に示します。
kind() | name() |
---|---|
@throws | @throws |
@throws | @exception |
@see | @see |
@see | @link |
@see | @linkplain |
@serial | @serial |
@serial | @serialData |
String text()
Tag[] inlineTags()
{@link}
タグのあるドキュメンテーション・コメントの場合、Tag
オブジェクトの配列を返します。ドキュメンテーション・コメント全体が、{@link}
タグで分割された複数の文字列に分けられます。この場合、配列の連続する各要素は、最初から最後まで順番に特定の文字列または{@link}
タグを表します。各文字列は、「Text」という名前のTag
オブジェクトで表されます。この場合、text()
は文字列を返します。各{@link}
タグは、名前が「@link」で種類が「@see」のSeeTag
によって表されます。たとえば、次のコメント・タグが指定されたとします。
This is a {@link Doc commentlabel} example.
次のTagオブジェクトの配列を返します。
Tag[] firstSentenceTags()
Tag
として表されます。インライン・タグは、種類「@link」のSeeTag
として表されます。ロケールが英語の場合、最初の文はJava言語仕様(最初のバージョン)に記述されている規則によって決定されます。"この文は、直後にスペース、タブ、または改行が続く最初のピリオド、または最初のタグ・ラインで終了します。"さらに、行は段落およびセクションの終わりを示す、次のようなHTMLタグで終了します。<p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>または</pre>。ロケールの言語が英語でない場合、文の終わりはBreakIterator.getSentenceInstance(Locale)
によって決定されます。Tag
オブジェクトの配列SourcePosition position()
バグまたは機能を送信
Java は米国ならびにその他の国における Oracle Corporation およびその関連企業の商標または登録商標です。
Copyright © 1993, 2014, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.