JAVA DOC の書き方について。

Question

eclipsで、jspとJAVAを書いています。

関数のJAVA DOC を下記のようにしています。

/**
 *
 * explain: DBクローズ
 * / functin: close()
 *
 * @user  : Yamada
 * @since : 2015-05-01
 *
 * @param Nothing
 *
 * @return {@code void}
 *
 * @exception RuntimeException
 *
 */

上記のように書いて（いくつかの関数に）、クラスを、eclipsでJAVA DOCへ吐き出したのですが、

問題１．「 * @return {@code void}」の戻り値が、JAVA DOCへ表示されません。
※「* @return {@code true:成功}, {@code false:失敗}」このように書くと表示されます。
戻り値が、voidの時は、どのように記述すればよいでしょうか？

問題２．変更履歴を書きたいのですが、全くどうやればよいかわかりません。@userを下の方に書いたり、@sinceを書いたり、直接「変更履歴」とかいてみたりしましたが、全部、くずれたり、表示されなかったりでだめでした。
どのように記述すればよいでしょうか？

問題３．user の名前が表示されません。なぜでしょうか？ sinceの日付は表示されます。

Answer 1

A1.

これは多分仕様ですね。voidのときは@returnタグは使えないみたいです。
Javadoc生成時に警告メッセージが出ているはずです。

A2.

説明の下に、

<pre>
変更履歴:
  2015-07-24: ＸＸＸの変更
  2015-07-25: ＹＹＹの変更
</pre>

のように書くのが簡単でしょうか。
他にもHTMLタグを試してみてください。

A3.

@userというタグはありません。これもJavadoc生成時に警告メッセージが出ているはずです。
書いた人という意味なら@authorタグを使えば出力されます。

リファレンスページのリンクを貼っておきますので参考にしてください。
特に「Javadocタグ」の項目を見てください。

javadoc - Java Platform, Standard Editionツール・リファレンス (Java8版)
javadoc - Java API ドキュメントジェネレータ (Java5版)

それ以外にも、例えば標準ライブラリーのJavadocの書き方も参考にしてみると良いと思います。

Comments

[退会済みユーザー]

@authorは、eclipsでJava Docを出力すると、「コンソールにこ@authyorは、関数にはつかえません。クラス宣言で使用できます。」とエラーがでます。
eclipsがJava Docの仕様とあってないのですね。

でも、後任者もおそらく、eclipsでJava Docを出力するだろうし、
こまったeclipsです。

[argius]

@authorはメソッドには使用できないようですね。失礼しました。
リンク先の「コンストラクタおよびメソッド・タグ」または「コンストラクタおよびメソッドドキュメンテーションタグ」という項目にメソッドで使用できるタグが記載されています。