web-dev-qa-db-ja.com

javadocで@文字をエスケープするにはどうすればよいですか？

Javadocで@シンボルをエスケープするにはどうすればよいですか？ {@code}タグの内側にある<pre>タグ内で使用しようとしています。

すでにhtmlエスケープ&#64;シーケンスを試しましたが、うまくいきませんでした。

javaescapingjavadoc
168
JayL

使用 - {@literal} javadocタグ：

/**
 * This is an "at" symbol: {@literal @}
 */

このためのjavadocは次のようになります。

This is an "at" symbol: @

もちろん、これはany文字に対して機能し、「特殊な」文字を表示する「公式にサポートされている」方法です。

また、最も簡単です-文字の16進コードとを知る必要はありません！

248
Bohemian

HTMLエンティティとして記述するだけです：

&#064;

ドキュメント「 javadoc-The Java API Documentation Generator

行を@文字で開始し、解釈させない場合は、HTMLエンティティ@を使用します。

これは、エスケープする必要があるany文字にHTMLエンティティを使用できることを意味し、実際に次のことができます。

テキストは、HTMLエンティティとHTMLタグを使用してHTMLで記述する必要があります。ブラウザでサポートされているHTMLのバージョンを使用できます。標準ドックレットは、カスケーディングスタイルシートとフレームを含めて、HTML 3.2準拠のコードを他の場所（ドキュメンテーションコメントの外部）に生成します。フレームセットのため、生成されたファイルにはHTML 4.0が推奨されます。

たとえば、小なり記号（<）および大なり記号（>）のエンティティは、&lt;および&gt;。同様に、アンパサンド（＆）は&amp;。

47
Frank V

私の解決策は

/**
 * Mapper Test Helper.
 *
 * add the following annotations above the class
 * <pre>{@code
 * // junit5
 * @literal @ExtendWith(SpringExtension.class)
 * // junit4
 * @literal @RunWith(SpringRunner.class)
 * }</pre>
 */
7
Yeongjun Kim

あなたは一般的なアイデアを得た、8進数表現を使用してみてください：&#064;

2
Yuval Adam