避免JavaDoc注释中的重复

我在写一个类，其中一些方法之间使用相同的xml。避免JavaDoc注释中的重复

例如

/** 
* 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的受影响的方法。

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

来源

2011-01-14 TERACytE

我想你可以指定一个类来创建它的java-doc。需要谷歌，但。 :) – Nishant 2011-01-14 20:55:20

我认为想要在Javadoc中重新使用变量定义是一个常见问题。 OP在这里询问关于XML文档的事实隐藏了它的普遍性 - 请参阅http://stackoverflow.com/questions/7021696/javadoc-reusable-parameter-values和http://stackoverflow.com/questions/1036565/is -it-re-use-param-descriptions-in-javadoc – 2013-02-13 15:39:39

为什么没有你的文档阅读：

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

然后，如果你更新你的XML，你只需更新架构？

来源

2011-01-14 20:53:46 JohnnyO

根据JavaDoc准则，您应该以句点结束句子。 – 2011-01-14 21:42:48

如何使用@see来引用其他方法？

来源

2011-01-14 20:55:07

我将文档（在胁迫下 - 实际上我认为文档是浪费时间，因为它几乎总是错误的 - 使用测试来记录您的系统所做的事情）CommonXML对象，而不是每个方法都需要一个对象类型。

来源

2011-01-14 20:57:12 time4tea

您不应该使用Javadoc来重复在别处定义的规范。参照符合规范。

来源

2011-01-15 00:34:31 EJP

你可以使用Doclava的include or sample tag来做到这一点。这些标签将示例文本从任意文件复制到输出javadoc html。 @include标签从给定文件逐字复制文本。 @sample标记通过一些修改来复制给定文件中的文本。

来源

2013-02-13 15:59:48

避免JavaDoc注释中的重复

回答

相关问题