java - 枚举文档注释中的 @author 和 @version 标签

标签 java javadoc

我是否必须将 @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/

相关文章:

java - 在 IDEA 中,如何为 javadoc 链接启用自动导入?

java - java的LinkedList类中的元素是否有索引?

java - 使用 maven 构建应用程序

java - Java自定义类Hashcode的实现

java - 如何为多个模块生成javadoc

java - 我的代码的每个部分真的都需要 JavaDoc/Comments 吗?

java - 为未重写的继承方法生成 JavaDoc

java - 使用 Spring 4 WebSocket 从 Java 推送消息

java - Spring 缓存 - 如何在 SPEL 中引用 bean 以通过 @Cacheable 启用条件缓存

具有相同目标的服务和 DAO 层类的 javadoc