专家建议使用 Javadoc
来验证每个公共类是否具有 javadoc 注释的工具。
Javadoc 是 Java 编程语言中的一种文档标准,用于生成 Java 代码的文档。Javadoc 注释以 /**
开头,后面跟着一个或多个 Javadoc 标记,再后面是 Java 代码的文档描述。
可以使用一些工具来自动生成 Javadoc 注释,例如 Javadoc 命令行工具,Maven 和 Gradle 等构建工具,以及 Eclipse 和 IntelliJ IDEA 等集成开发环境。
以下是一个使用 Javadoc 命令行工具生成注释的例子:
javadoc -d output_directory -sourcepath src -subpackages packageName
其中 -d
参数指定生成注释的输出目录,-sourcepath
参数指定源代码的路径,-subpackages
参数指定要生成注释的包。
生成的 Javadoc 注释将保存在指定的输出目录中,以供将来参考和使用。
领取专属 10元无门槛券
手把手带您无忧上云