java - 避免 JavaDoc 注释中的重复

Question

我正在编写一个类，其中一些方法之间使用相同的 xml。

例如

/**
 * Sample Response:
 * <xmp>
 *      <myXML>
 *          <stuff> data </stuff>
 *      </myXML>
 * </xmp>
 */
 CommonXML Method1();

/**
 * Sample Submission:
 * <xmp>
 *      <myXML>
 *          <stuff> data </stuff>
 *      </myXML>
 * </xmp>
 */
 void Method2(CommonXML xml);

我想编写我的文档，以便在 xml 更改时我有一个资源可以修改，而不是为受影响的方法更新所有 JavaDoc。

有谁知道如何做到这一点？

Answer 1

为什么不阅读您的文档:

/**
 * Returns an XML file conforming to the CommonXML schema, available here 
 * (link-to-schema).
 **/

那么，如果您更新 XML，您只是更新了架构？