0

コードに javaDoc コメントを追加し、返す XML ドキュメントの構造を概説している場合、属性を表す最良の方法は何ですか? これに対するベストプラクティスはありますか?

私の javaDoc コメントの一般的な構造は次のようになります。

/**
 * ...
 * 
 * @return XML document in the form:
 * 
 * <pre>
 * &lt;ROOT_ELEMENT&gt;
 *    &lt;AN_ELEMENT&gt;
 *    &lt;MULTIPLE_ELEMENTS&gt;*
 * &lt;/ROOT_ELEMENT&gt;
 * </pre>
 */
4

2 に答える 2

1

あなたの質問を明確に理解しているかどうかわかりません。

私の推奨する解決策は、戻りパラメーターの説明にスキーマ XSD または DTC を埋め込むことです。あなたのソリューションは、複数の要素などを表現する方法に関する個人的なイディオムにつながるようです。XSD や DTD などの標準を使用すると、XML ドキュメントの構造を記述する方法について、よく知られた認識されている言語を使用できます。

Eclipse を使用している場合の JavaDoc 表現に関しては、[保存アクション] でドキュメントをフォーマットするように指定できます。このようにして、> と < を使用して通常どおりに記述し、エスケープされた HTML コードに変換されることを確認できます。

于 2008-10-01T11:00:23.267 に答える
0

結局、私はちょうど行きました：

/**
 * ...
 * 
 * @return XML document in the form:
 * 
 * <pre>
 * &lt;ROOT_ELEMENT&gt;
 *    &lt;AN_ELEMENT attribute1 attribute2&gt;
 *    &lt;MULTIPLE_ELEMENTS&gt;*
 * &lt;/ROOT_ELEMENT&gt;
 * </pre>
 */
于 2008-10-03T10:12:57.787 に答える