web-dev-qa-db-ja.com

カスタムjavadocタグを作成する方法は？

@pre/@postなどのカスタムjavadocタグを作成するにはどうすればよいですか？私はそれを説明するいくつかのリンクを見つけましたが、私はそれらに運がありませんでした。これらはいくつかのリンクです：

http://www.developer.com/Java/other/article.php/3085991/Javadoc-Programming.html

http://Java.Sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html

javajavadoc
27
Carlos

Javaコード

/**
 * @custom.mytag hey ho...
 */

Java docオプション

-tag custom.mytag:a:"This is my Tag:"

出力

これは私のタグです：

ちょっとホー...

25
appsthatmatter

カスタムタグはHTMLを使用して作成しないでください。これは、javadocが実装やデータの表示方法を変更する可能性があるためです。将来的には、 Markdown の使用が開始される可能性があります。また、Javadocエクスポーターは不足している情報をキャッチしないため、空の「タグ」があります。

まず、必要なタグを使用します。

/**
 * Comments and a {@link #methodLink} for this method.
 * 
 * @tt.wrapper {@link OtherClass}
 *
 */
public String extractName() {
    // method contents
}

カスタムタグの形式は@[prefix].[tagName]であることに注意してください。これは、ドックレット（または別のEclipseプラグイン）が同じ名前の独自のタグをリリースする可能性があり、タグが標準タグをオーバーライドするためです。プレフィックスを追加して、その可能性を低くします。

ドックレットからのコメント。

将来の標準タグをオーバーライドする可能性のあるカスタムタグ：@wrapperオーバーライドの可能性を回避するには、カスタムタグ名に少なくとも1つのピリオド文字（。）を使用します。

次に、このカスタムタグ@tt.wrapperについてJavadocエクスポータに通知する必要があります。 Eclipse（私の場合はIndigo）のProject > Generate Javadoc..に移動します。

このダイアログの最初の2つの画面の設定を構成した後（「次へ」を使用して画面を変更）、次の画面が表示されます。

Third configuration screen for Eclipse Doclet Javadoc Export

「ExtraJavadocoptions ..」テキストボックスには、Javadocエクスポータがタグに相当するHTMLを作成するために追加する必要のある値があることに注意してください。

私たちの場合、オプションは次のとおりです（複数のタグが必要な場合は、新しい行に配置します）。

-tag tt.wrapper:a:"API Wrapper:"

これで、Javadocをエクスポートするときに（ [〜＃〜] ant [〜＃〜] スクリプトを保存して、毎回このダイアログを実行する必要がないようにすることをお勧めします）、カスタムがあります。説明とその下の値を太字でタグ付けします。

P.S.カスタムタグのオートコンプリートを追加する機能を追加する方法をまだ見つけていませんが、Indigoでは不可能のようです。将来のリリースで使用される可能性があります（Junoに搭載されているかどうかはわかりません）。

13
knownasilya

複数が必要な場合は、コマンドライン引数を要求するjavadoc -tag pre -tag post -tag invariantのような操作を行います。 HTMLのものを使用しないでください

0
trevren11