[解決済み] 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で利用可能なタグの記述の完全なリストは以下のとおりです。 こちら .
関連
-
java Mail send email smtp is not authenticated by TLS encryption solution.
-
java -serverコマンドで「Error: no `server' JVM at ... jvm.dll」を解決する方法です。
-
[解決済み] ArrayListの初期化を1行で行う。
-
[解決済み] ランダムな文字列を使用するこのコードは、なぜ "hello world" と表示されるのですか?
-
[解決済み] Sublime Text 2を使ってHTMLコードを再フォーマットするにはどうしたらいいですか?
-
[解決済み] javadocでメソッドを参照するには?
-
[解決済み] Javadocで外部URLへのリンク?
-
[解決済み] javadocでメソッドパラメータへの参照を追加する方法は?
-
[解決済み】JSP 2を使用して、JSPファイル内のJavaコードを回避するにはどうすればよいですか?
-
[解決済み】他のクラスのメソッドへのJavadocリンク
最新
-
nginxです。[emerg] 0.0.0.0:80 への bind() に失敗しました (98: アドレスは既に使用中です)
-
htmlページでギリシャ文字を使うには
-
ピュアhtml+cssでの要素読み込み効果
-
純粋なhtml + cssで五輪を実現するサンプルコード
-
ナビゲーションバー・ドロップダウンメニューのHTML+CSSサンプルコード
-
タイピング効果を実現するピュアhtml+css
-
htmlの選択ボックスのプレースホルダー作成に関する質問
-
html css3 伸縮しない 画像表示効果
-
トップナビゲーションバーメニュー作成用HTML+CSS
-
html+css 実装 サイバーパンク風ボタン
おすすめ
-
springboot project MIMEタイプ text/htmlで転送された静的ファイルを読み込む。
-
undefinedeclipse エラー。この行に複数のアノテーションが見つかりました: - 文字列を型解決に解決できない
-
Spring Boot による HTTPS アクセスの設定
-
コンストラクタの呼び出しは、コンストラクタのエラー理解の最初のステートメントである必要があります。
-
java Mail send email smtp is not authenticated by TLS encryption solution.
-
Intellij IDEAのエラー「CreateProcess error=2, system could not find specified file」に対する完璧な解決策です。
-
xxx:jarのアーティファクトディスクリプタの読み込みに失敗した問題は解決しました。
-
node js npm gruntインストール、elasticsearch-head 5.Xインストール
-
javaコンパイル時のエラー:不正な文字 '\ufeff' に対する解決策です。
-
JSPで「リストが型解決できない!」の解決方法