1. ホーム
  2. java

[解決済み] Javadocのコメントで複数行のコード例

2022-03-17 16:55:26

質問

あるメソッドのJavadocコメントに含めたい小さなコード例があります。

/**
 * -- ex: looping through List of Map objects --
 * <code>
 * for (int i = 0; i < list.size(); i++) {
 *      Map map = (Map)list.get(i);
 *      System.out.println(map.get("wordID"));
 *      System.out.println(map.get("word"));
 * }
 * </code>
 * 
 * @param query - select statement
 * @return List of Map objects
 */

問題は、Javadocに表示されるコード例で、改行がなく読みにくいことです。

-- ex: looping through List of Map objects -- for (int i = 0; i list.size(); i++) { Map map = (Map)list.get(i); System.out.println(map.get("wordID")); System.out.println(map.get("word")); } 
Parameters
query - - select statement 
Returns:
List of Map objects 

codeタグで改行を処理すると思っていたのは間違いだったようです。 Javadocコメントでコード例をフォーマットする最良の方法は何ですか?

どのように解決するのですか?

すでに述べた <pre> タグを使用する必要があります。 @code JavaDocアノテーションは、HTMLエンティティの問題(特にGenericsの問題)を解決するために、例えば、以下のような生活をより簡単にすることができます。

* <pre>
* {@code
* Set<String> s;
* System.out.println(s);
* }
* </pre>

正しいHTMLが出力されます。

Set<String> s;
System.out.println(s);

を省略する一方で @code ブロック(または <code> タグを使用すると、次のようなHTMLになります。

Set s;
System.out.println(s);

参考までに、Java SE 8で利用可能なタグの記述の完全なリストは以下のとおりです。 こちら .