在JavaDoc中使用自定义标记记录业务逻辑?

为什么不把它放在普通的Javadoc注释中呢?作为对类、方法等的总结的解释,这是完全可以接受的,而且大部分JDK本身也是这样记录的。

如果这对您来说还不够好,也许您可以创建一个自定义属性来标记成员/方法/类,然后您可以通过编程轻松地扫描这些类并找到所有注释。

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

如果您使用的是Java1.5+,那么可以使用常规注释,并将它们编译成报告。 Here