質問: 以下のようなJavadocコメントを残したいと考えています。 ``` XMLでは以下のように設定してください。 ``` しかし、以下のように書くと、アスタリスクースラッシュ(*/)があるせいでうまくいきませんでした。 ``` /** * XMLでは以下のように設定してください。 * * {@code * * * * } * */ ``` や{@code}を使わずに、一つ一つエスケープしていくというのは1つの手かとは思いますが、実際に残したいコメントはXML部分が非常に長いため、XML部分は必要以上にエスケープしたくありません。 {@literal *}としてみたり、スラッシュを/でエスケープする方法も試しましたが、(または{@code}?)を使っているせいか、うまくいきませんでした。 なにか妙案あれば、ご教示いただけないでしょうか。
回答: 妙案ではありませんが 運用例として回答します。 私は本家スタックオーバーフローの類似質問に対する回答のように、愚直にコメントの一括置換で対応しています。 その上でjavadocから生成したヘルプページへとコメント内で誘導します。 (ヘルプページはCIツールや夜間バッチなどで定期的に更新します) 多少不便かもしれませんが、ルール化しておけば他の開発者もそれに従ってAPIリファレンスが充実してくるので、運用で困ったことはありません。 ``` /** * Returns true if the specified string contains "*/". * ↓ "/" を "/" に一括置換 * Returns true if the specified string contains "*/". * @see xmlサンプルをコピペしたい場合はこちら */ public boolean containsSpecialSequence(String str) ``` ※社内ではjava以外の言語を使っているので雰囲気でとらえてください。`@see`の構文が間違っていたらすみません。