web-dev-qa-db-ja.com

フォーマットせずにjavadocで「<」と「>」を使用するにはどうすればよいですか?

<xmlElement>はjavadocでは表示されません。タグにはテキストのフォーマットに関する特別な機能があるためです。

Javadocでこの文字を表示するにはどうすればよいですか?

104
Tom Brito

<には&lt;を、>には&gt;を使用できます。

142
Pavitar Singh

JavaDocの最近のバージョンは{@literal A <B> C}をサポートしています。これにより、コンテンツが正しく出力されます(生成されたHTMLの「<」および「>」をエスケープします)。

http://download.Oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html を参照してください

60

XMLは実際のコードであると考えると、JavadocのXMLスニペットは{@literal A <B> C}タグよりも{@code A <B> C}タグに適していると思います。

{@code}タグは、コンテンツを実際のコードとして際立たせる固定幅フォントを使用しています。

39

HTMLとしてエスケープします:&lt;および&gt;

14
duffymo

山括弧の1つに対応するHTMLのみを使用する必要があります。 <は、いずれかの&lt;または&#60;。実際のJavadocから抜粋したサンプルを次に示します。

 <pre> 
 lt; complexType> 
 lt; complexContent> 
 lt; restriction base = "{http://www.w3.org/2001/ XMLSchema} anyType "> 
 lt; sequence> 
 [...] 

これは次のように表示されます。

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
9
Pops

markdownを使用するようにMavenを設定する の場合、バッククォートで囲むことができます。

`A<B>C`は、{@code A<B>C}

2
Owen