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

在JavaDoc中使用自定义标记记录业务逻辑?,java,javadoc,Java,Javadoc,是否可以使用JavaDoc从自定义标记创建注释列表?我想在整个代码中标记一个业务规则,但它实际上不属于我所知道的任何现有标记。我想如果有一个标签做了类似的事情: @注意逻辑-这个容器中只能有12个小部件 这是一种约束或需求的反向文档,我想记录它们,因为它们不一定是原始规范的一部分。我想在源代码中记录它的一个原因是源代码似乎永远不会丢失,而设计规范,嗯。。。(更不用说似乎没有人读过了)为什么不把它放在普通的Javadoc注释中呢?作为对类、方法等的总结的解释,这是完全可以接受的,而且大部分JDK本

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

@注意逻辑-这个容器中只能有12个小部件


这是一种约束或需求的反向文档,我想记录它们,因为它们不一定是原始规范的一部分。我想在源代码中记录它的一个原因是源代码似乎永远不会丢失,而设计规范,嗯。。。(更不用说似乎没有人读过了)

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

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

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

XDoclet应该能够定制您想要做的事情


如果您使用的是Java1.5+,那么可以使用常规注释,并将它们编译成报告。这些是说明。这肯定比XDoclet方法更简单。

唯一的问题是,我不介意将它们收集到一个较长的报告中,尽管我知道,如果写评论的人认为它们总是在方法的范围内被阅读,那么一些上下文就会丢失。但除此之外,我不知道你可以做自定义注释的事情。