public interface SeeTag extends Tag
{@link}
を使ってコメントに合わせたり、@see
を使って個別のブロック・コメントに合わせたりすることができます。name()
メソッドは、タグに応じて「@link」または「@see」を返します。kind()
メソッドは両方のタグで「@see」を返します。修飾子と型 | メソッドと説明 |
---|---|
String |
label()
@see タグのラベルを取得します。 |
ClassDoc |
referencedClass()
@seeのクラス名の部分によって参照されるクラスdocを取得します。
|
String |
referencedClassName()
@see 参照のクラス名またはインタフェース名を取得します。 |
MemberDoc |
referencedMember()
@see により参照されたフィールド、コンストラクタ、またはメソッドのメンバーdocを取得します。 |
String |
referencedMemberName()
@see 参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。 |
PackageDoc |
referencedPackage()
@see がパッケージだけを参照するときにパッケージdocを取得します。 |
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString
String label()
@see
タグのラベルを取得します。ラベルが存在しない場合はnullを返します。次に例を示します。
@see String#trim() the trim method
PackageDoc referencedPackage()
@see
がパッケージだけを参照するときにパッケージdocを取得します。パッケージが見つからない場合、あるいは@see
が他の要素(クラス、インタフェース、フィールド、コンストラクタ、メソッド)または要素以外を参照する場合は、nullを返します。次に例を示します。
@see java.lang
java.lang
のPackageDoc
を返します。String referencedClassName()
@see
参照のクラス名またはインタフェース名を取得します。元の@see
タグで指定された名前が完全修飾名の場合、あるいはクラスまたはインタフェースが見つからない場合、名前は完全修飾名です。そうでない場合は非修飾名です。@see
がパッケージ名だけを参照する場合は、代わりにパッケージ名を返します。次に例を示します。
@see String#valueOf(java.lang.Object)
@see java.lang
」の場合、「java.lang」が返されます。@see
が@see <a href="java.sun.com">
などのような要素以外を参照する場合は、nullが返されます。ClassDoc referencedClass()
@see String#valueOf(java.lang.Object)
java.lang.String
のClassDoc
を返します。String referencedMemberName()
@see
参照のフィールド、コンストラクタ、またはメソッドの部分文字列を取得します。参照が他の要素または要素以外への参照の場合はnullを返します。メンバー・クラス(ネストされたクラス)への参照はnullを返します。次に例を示します。
@see String#startsWith(String)
MemberDoc referencedMember()
@see
により参照されたフィールド、コンストラクタ、またはメソッドのメンバーdocを取得します。メンバーが見つからなかった場合、または参照が他の要素または要素以外への参照の場合はnullを返します。メンバー・クラス(ネストされたクラス)への参照はnullを返します。次に例を示します。
@see String#startsWith(java.lang.String)
startsWith
のMethodDoc
を返します。 バグまたは機能を送信
Java は米国ならびにその他の国における Oracle Corporation およびその関連企業の商標または登録商標です。
Copyright © 1993, 2014, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.