モジュール jdk.javadoc
パッケージ com.sun.javadoc

インタフェースParamTag

  • すべてのスーパー・インタフェース:
    Tag
    @Deprecated(since="9",
            forRemoval=true)
public interface ParamTag
extends Tag
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    特定のドキュメンテーション・タグ@paramを表します。 パラメータ・タグの名前の部分とコメントの部分を格納します。 @paramタグは、メソッド、コンストラクタ、または型のパラメータを表す場合があります。

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      boolean isTypeParameter()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このParamTagが型パラメータに対応する場合は、trueを返します。
      String parameterComment()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このParamTagに関連するパラメータのコメントを返します。
      String parameterName()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このParamTagに関連するパラメータまたは型パラメータの名前を返します。

    • メソッドの詳細

      • parameterName

        String parameterName()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このParamTagに関連するパラメータまたは型パラメータの名前を返します。 型パラメータを区切るための角括弧は名前の一部ではありません。
        戻り値:
        パラメータの名前。

      • parameterComment

        String parameterComment()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このParamTagに関連するパラメータのコメントを返します。
        戻り値:
        パラメータのコメント。

      • isTypeParameter

        boolean isTypeParameter()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このParamTagが型パラメータに対応する場合は、trueを返します。 メソッドまたはコンストラクタの通常のパラメータに対応する場合は、falseを返します。
        戻り値:
        このParamTagが型パラメータに対応する場合は、true。
        導入されたバージョン:
        1.5