27

残念ながら、HTML には CDATA はありません。

XML を含むコメントを追加するのに最適なので、これは残念javadocです。たとえば、次のように < と > をエスケープする必要はありません。

/**<![CDATA[ This parses <complexType name=""> ]]>*/

ただし、javadocCDATA セクションを認識して HTML に変換することは可能です。例えば：

This parses &lt;complexType name=""&gt;

または、CDATA よりも単純な構文を使用することもできます。拡張可能であるためjavadoc、誰かがこの機能を追加した可能性があります。または、javadocすでに内部のどこかに埋もれているかもしれません... 誰か知っていますか？

4

4 に答える 4

46

JavaDoc の@codeタグを使用できます。/** This parses {@code <complexType name="">} */

于 2009-11-23T09:41:46.920 に答える
33

@Fabianの答えを拡張して、私は と の両方を使用<pre>し{@code ...}ます。ソース コードとして XML を使用した例を次に示します。

/*Outputs data from a result set to an XML
 * with following structure:
 * <pre>
 * {@code
 * <row>
 *  <FIELD1>gregh</FIELD1>
 *  <FIELD2>487</FIELD2>
 *  <!-- etc. -->
 * </row>
 * <!-- more rows-->
 * }
 * </pre>
 */

<pre>複数の行にコードを記述し、その構造を維持することができます。

Eclipse 3.6.1 でテスト済み。

于 2011-12-28T10:57:04.117 に答える
8

バグ 206319とバグ 206345にもかかわらず、完全な HTML エスケープに頼らずに{@code}${dollar_sign_variables} が Eclipse で正しくレンダリングされるように、波括弧の周りのタグを閉じてから再度開きます。

/*
 * <pre>
 * {@code
 * <outer>
 *   <inner1>Text</inner1>
 *   <inner2>$}{ "script" }{@code </inner2>
 * </outer>
 * }
 * </pre>
 */

Eclipse Indigo SR2 (3.7.2) で次のようにレンダリングされます。

<outer>
  <inner1>Text</inner1>
  <inner2>${ "script" }</inner2>
</outer>
于 2012-09-26T14:06:32.377 に答える
3

私はかなりの数の解決策を試しましたが、どれも私のニーズを十分に満たすものではありませんでした。pre + @code (または @literal) タグを実行すると、通常は機能します。

 <pre>
 {@literal
 <configFiles>
   <configFile>
     <type>LOGICAL_INDEX_CONFIG</type>
   </configFile>
 </configFiles>}
 </pre>

問題は、html に ${dollar_sign_variables} がある場合はどうなるかということです。(これは、ドキュメントで maven フィルタリングに依存する xml の例を使用している場合によく発生します)。${ITEM_INDEX_TO_LOGICAL} があるとします。Eclipse は次のようにレンダリングします。

<configFiles>
  <configFile>
     ITEM_INDEX_TO_LOGICAL

   }

最終的に、適切にレンダリングするには、html エスケープ メソッド (これを使用できます)に固執するしかありませんでした。

これ：

 &lt;configFiles&gt;
   &lt;configFile&gt;
     &lt;type&gt;${ITEM_INDEX_TO_LOGICAL}&lt;/type&gt;
   &lt;/configFile&gt;
 &lt;/configFiles&gt;

次のようにレンダリングします。

 </configFiles>
   <configFile>
     <type>${ITEM_INDEX_TO_LOGICAL}</type>
   </configFile>
 </configFiles>

これは残念ながら、Javadoc をレンダリングしない限り、文書化されている「xml の例」を本当に理解できない立場に置かれることになります。幸いなことに、Eclipse はその場でこれを行うことができます...

于 2012-06-06T07:49:44.357 に答える