我是否必须将 @author
和 @version
标记放入枚举的文档注释中?
How to Write Doc Comments for the Javadoc Tool说
* @author
(classes and interfaces only, required)
* @version
(classes and interfaces only, required. See footnote 1)
我的 IDE 的枚举文档注释模板包括 @author
。
最佳答案
您将其放入 Javadoc,无论您的组织要求什么,都应将其放入 Javadoc。归根结底,它是一个沟通工具,您可以决定要使用它的哪些部分,不使用它的哪些部分。
关于java - 枚举文档注释中的 @author 和 @version 标签,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/6988212/