web-dev-qa-db-ja.com

JavaDoc：ノート/注釈をドキュメントに追加する場所は？

C＃でコーディングするとき、クラスまたはメソッドの実装に関するメモを提供したり、実装しているものの理論についての情報を提供したりするために、タグremarksは常に非常に役立ちます。私は現在Javaを使用していますが、これに適切なJavaDocタグが見つかりません。おそらくJavaでこれを別の方法で実行します？

javacoding-stylejavadoc
43
tunnuz

私の知る限り、メモや注釈用の専用のJavadocタグはありません。一般に、Javadocの最初の文は、クラス/メソッド/フィールドの簡単な説明を提供する必要があります。次に、完全な説明が続きます。また、メモを含める場合は、「メモ：」を前に付けた特別な段落で十分です。

/**
 * Brief description. Full description of the method, generally without
 * implementation details.
 * <p>
 * Note: Additional information, e.g. your implementation notes or remarks.
 * </p>
 * @param input description of the parameter
 * @return description of return value
 * 
 * @since version
 * @author name of the author
 */
public boolean doSomething(String input)
{
    // your code
}
43
janhink

Javaプログラミング言語の反復8により、開発者は最終的に、コードのドキュメントで使用できる3つの追加タグを提供されました。これは、ニーズを満たすはずです：@apiNote、@implSpecおよび@implNote（たとえば、より詳細な議論のために参照してください： blog.codefx.org/Java/new-javadoc-tags/ ）。

21
fbahr

実装の詳細がJavadocの一部であるほど興味深いと思う場合は、Javadocコメント自体の段落にそれらを提供するだけです。

/**
 * Does something.
 * <p>
 * <b>Implementation details:</b><br />
 * Blah blah blah...
 * </p>
 */
public void doSomething() {
    // ...
}
5
Laurent Pireyn

独自のカスタムタグを作成することもできます。

カスタムタグ「@note」を含むjavadocコメントは次のとおりです。

    /**
     * Quark represents a quark.
     *
     * @note If you spin a quark, it will spin forever!
     */
    public class Quark {

    }

上記のjavadocsを生成するには、次のようにjavadocを実行します。

javadoc -tag note：a： "Note：" Quark.Java

ソース： http://www.developer.com/Java/other/article.php/3085991/Javadoc-Programming.htm

5
Naveen