【发布时间】：2010-10-31 07:32:31
【问题描述】：
是否可以使用 JavaDoc 从自定义标签创建笔记列表？我有一个要在整个代码中标记的业务规则，它确实不属于我所知道的任何现有标签。我想如果有一个标签做了类似的事情：
@note 逻辑 - 此容器中只能有 12 个小部件
这是一种对约束或要求的反向文档，我想记录这些，因为它们不一定是原始规范的一部分。我想在源代码中记录它的一个原因是源代码似乎永远不会丢失，而设计规范，嗯......（更不用说似乎没有人阅读它们）
【问题讨论】：
【发布时间】：2010-10-31 07:32:31
【问题描述】：
为什么不把它放在普通的Javadoc cmets 本身呢？作为对类、方法等摘要的解释。这是完全可以接受的，也是大部分 JDK 本身的文档记录方式。
如果这对您来说还不够好，也许您可以创建一个自定义属性来标记成员/方法/类，然后您可以轻松地以编程方式扫描类并找到所有笔记。
@CustomNote("You can only have twelve widgets in this container")
public class WidgetContainer {
...
【讨论】：
-
唯一的事情是，我不介意能够将它们收集到一份更长的报告中，尽管我知道如果编写 cmets 的人假设它们将始终在方法的范围。
-
但除此之外，我不知道你可以做自定义笔记的事情。
XDoclet 应该能够根据您的需要进行定制。
如果您使用的是 java 1.5+，您可以使用常规注释，并将它们编译成报告。 Here 是说明。这绝对比 XDoclet 方法简单。
【讨论】：