java - 在 JavaDoc 中使用自定义标签记录业务逻辑？

Question

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

@note 逻辑 - 此容器中只能有 12 个小部件

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

Answer 1

为什么不把它放在普通的 Javadoc 注释中呢？作为对类、方法等摘要的解释。这是完全可以接受的，并且它是大部分 JDK 本身的文档记录方式。

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

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

Answer 2

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

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