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

解决方案

不确定我是否清楚理解问题。

我的首选解决方案是将架构XSD或者DTC嵌入到return参数的描述中。解决方案似乎导致了关于如何表示诸如多个元素或者其他元素之类的个人成语。使用XSD或者DTD之类的标准，可以使我们掌握如何描述XML文档结构的众所周知的语言。

关于JavaDoc表示形式(如果使用的是Eclipse)，可以在"保存操作"下指定格式来设置文档格式。这样，我们可以正常地使用>和<编写代码，然后将其转换为转义的HTML代码。

最后，我只用了：

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