xml - 在 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，您可以在 Save Actions 下指定以格式化您的文档。这样您就可以正常使用 > 和 < 编写代码，并看到它转换为转义的 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>
 */