在 javaDoc 中，在 XML 中表示属性的最佳方式是什么？ [关闭]

Question

当您将 javaDoc cmets 添加到您的代码中并概述您要传回的 XML 文档的结构时，表示属性的最佳方式是什么？有这方面的最佳做法吗？

我的 javaDoc cmets 的一般结构是这样的：

/**
 * ...
 * 
 * @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，您可以在 Save Actions 下指定以格式化您的文档。这样你就可以正常使用 > 和

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