使用JavaDoc中的自定义标记记录业务逻辑？

Question

是否可以使用JavaDoc从自定义标签创建注释列表？我有一个业务规则，我想在整个代码中标记，它实际上不属于我所知道的任何现有标记。我想如果有一个标签做了类似的事情：

@note logic - 你在这个容器中只能有12个小部件

这是对约束或要求的反向记录，我想记录这些，因为它们不一定是原始规范的一部分。我想在源代码中记录它的一个原因是源代码似乎永远不会丢失，而设计规范，嗯...（更不用说似乎没有人阅读它们）

Answer 1

为什么不把它放在正常的Javadoc注释中呢？作为对类，方法等的总结的解释。这是完全可以接受的，并且它是大多数JDK本身被记录的。

如果这对您来说不够好，也许您可​​以创建一个自定义属性来标记成员/方法/类，那么您可以轻松地以编程方式扫描类并找到所有笔记。

@CustomNote("You can only have twelve widgets in this container")
public class WidgetContainer { 
    ...

Answer 2

XDoclet应该能够根据您的需要进行自定义。

如果您使用的是Java 1.5+，则可以使用常规注释，并将它们编译成报告。 Here是说明。这绝对比XDoclet方法简单。