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

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

Tag

public interface ParamTag
extends Tag

特定のドキュメンテーションタグ @param を表し、パラメータタグの名前の部分とコメントの部分を格納します。@param タグは、メソッド、コンストラクタ、または型のパラメータを表す場合があります。

メソッドの概要

boolean	isTypeParameter() この ParamTag が型パラメータに対応する場合は、true を返します。
String	parameterComment() この ParamTag に関連するパラメータのコメントを返します。
String	parameterName() この ParamTag に関連するパラメータまたは型パラメータの名前を返します。

インタフェース com.sun.javadoc.Tag から継承されたメソッド

firstSentenceTags, holder, inlineTags, kind, name, position, text, toString

メソッドの詳細

parameterName

String parameterName()

この ParamTag に関連するパラメータまたは型パラメータの名前を返します。型パラメータを区切るための角括弧は名前の一部ではありません。

戻り値:

パラメータの名前

parameterComment

String parameterComment()

この ParamTag に関連するパラメータのコメントを返します。

戻り値:

パラメータのコメント

isTypeParameter

boolean isTypeParameter()

この ParamTag が型パラメータに対応する場合は、true を返します。メソッドまたはコンストラクタの通常のパラメータに対応する場合は、false を返します。

戻り値:

この ParamTag が型パラメータに対応する場合は、true

導入されたバージョン:

1.5