com.sun.javadoc
インタフェース Tag

すべてのスーパーインタフェース:

java.io.Serializable

既知のサブインタフェースの一覧:

ParamTag, SeeTag, SerialFieldTag, ThrowsTag

public interface Tag

extends java.io.Serializable

特定のドキュメンテーションタグ (@since、@author、@version など) を表します。各タグ (「@since 1.2」など) は、タグ名 (「@since」など) とタグテキスト (「1.2」など) を保持します。構造を持ったタグや特別な処理が必要なタグは、サブクラス (ParamTag、SeeTag、および ThrowsTag) で処理されます。

関連項目:

SeeTag, ParamTag, ThrowsTag, Doc.tags()

メソッドの概要

Tag[]	firstSentenceTags() コメントの最初の文をタグとして返します。
Tag[]	inlineTags() タグ @link が埋め込まれたドキュメンテーションコメントに対して、Tag を含むテキストと SeeTag で構成される Tag の配列を返します。
java.lang.String	kind() このタグの種類を返します。
java.lang.String	name() このタグの名前を返します。
java.lang.String	text() このタグのテキスト (タグ名よりもあとの部分) を返します。
java.lang.String	toString() このオブジェクトを文字列に変換します。

メソッドの詳細

name

public java.lang.String name()

このタグの名前を返します。

kind

public java.lang.String kind()

このタグの種類を返します。

text

public java.lang.String text()

このタグのテキスト (タグ名よりもあとの部分) を返します。

toString

public java.lang.String toString()

このオブジェクトを文字列に変換します。

オーバーライド:

クラス java.lang.Object 内の toString

inlineTags

public Tag[] inlineTags()

タグ @link が埋め込まれたドキュメンテーションコメントに対して、Tag を含むテキストと SeeTag で構成される Tag の配列を返します。たとえば、「This is an example of inline tags for a documentaion comment {@link Doc commentlabel}」(中括弧内の Doc は SeeTag とまったく同じ構文を持つもので、「commentlabel」は Html リンクのラベル) というコメント文字列の場合、「This is an example of inline tags for a documentation comment」というコメントテキストを持つ Tag である 1 つ目の要素、および「Doc」で参照されるクラスと「commentlabel」という Html リンクのラベルを持つ SeeTag である 2 つ目の要素とともに Tag の配列が返されます。

戻り値:

インライン SeeTag が含まれたタグの配列 Tag[]

関連項目:

ParamTag, ThrowsTag

firstSentenceTags

public Tag[] firstSentenceTags()

コメントの最初の文をタグとして返します。インラインタグ ({@link reference} タグ) を含みますが、通常のタグは含みません。プレーンテキストの各セクションは、種類「Text」の Tag として表されます。インラインタグは、種類「link」の SeeTag として表されます。ロケールが英語の場合、最初の文は Java 言語仕様 (最初のバージョン) に記述されている規則によって決定されます。"この文は、後ろに空白文字、タブ、または行末記号が続く最初のピリオド、または最初のタグラインで終了します。" さらに、行は段落およびセクションの終わりを示す <p>、</p>、<h1>、<h2>、<h3>、<h4>、<h5>、<h6>、<hr>、<pre>、</pre> などの HTML タグで終了します。ロケールの言語が英語でない場合、文の終わりは java.text.BreakIterator.getSentenceInstance(Locale) によって決定されます。

戻り値:

コメントの最初の文を表す Tag の配列