在javaDoc中，在XML中表示属性的最佳方法是什么？

Question

当您在代码中添加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>
 */

Answer 1

我不确定我是否明白你的问题。

我首选的解决方案是将模式XSD或DTC嵌入到返回参数的描述中。你的解决方案似乎导致了如何表达多元素或其他元素的个人习语。使用像XSD或DTD这样的标准，您可以获得有关如何描述XML文档结构的知名语言。

关于JavaDoc表示，如果您使用的是Eclipse，则可以在“保存操作”下指定格式化文档。这样你就可以用＆gt;正常书写和＆lt;并看到它转换为转义的HTML代码。

Answer 2

最后，我跟着：

/**
 * ...
 * 
 * @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>
 */