是否可以使用 JavaDoc 从自定义标记创建注释列表?我有一个业务规则,我想在整个代码中标记它,它确实不属于我所知道的任何现有标签。我想如果有一个标签做了类似的事情:
@note 逻辑 - 此容器中只能有 12 个小部件
这是一种约束或要求的反向文档,我想记录这些,因为它们不一定是原始规范的一部分。我想在源代码中记录它的一个原因是源代码似乎永远不会丢失,而设计规范,嗯......(更不用说似乎没有人阅读它们)
最佳答案
为什么不把它直接放在普通的 Javadoc 注释中呢?作为类、方法等摘要的解释。这是完全可以接受的,并且这也是大多数 JDK 本身的文档方式。
如果这对您来说还不够好,也许您可以创建一个自定义属性来标记成员/方法/类,然后您可以轻松地以编程方式扫描类并找到所有注释。
@CustomNote("You can only have twelve widgets in this container")
public class WidgetContainer {
...
关于java - 使用 JavaDoc 中的自定义标签记录业务逻辑?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/950185/