Debian Java文档怎么生成 - 问答

Debian环境下生成Java文档的两种常用方式

使用Doxygen从源码注释生成API文档（类、方法、包说明），输出HTML/LaTeX/PDF等。
使用Swagger/OpenAPI在Spring Boot等框架中生成RESTful API文档，并提供Swagger UI在线查看与调试。

使用Doxygen生成Java API文档

安装与初始化
- 安装：sudo apt-get install doxygen
- 生成配置模板：在项目根目录执行：doxygen -g（精简模板：doxygen -s -g）
关键配置示例（编辑生成的 Doxyfile）
- 启用Java支持与文件识别
  - OPTIMIZE_OUTPUT_JAVA = YES
  - *FILE_PATTERNS = .java
  - RECURSIVE = YES
- 选择输出格式与目录
  - GENERATE_HTML = YES
  - GENERATE_LATEX = YES（如需PDF，后续用LaTeX转PDF）
  - OUTPUT_DIRECTORY = docs（自定义输出目录）
- 注释风格与可见性
  - JAVADOC_AUTOBRIEF = YES
  - EXTRACT_ALL = YES
  - EXTRACT_PRIVATE = YES
生成与查看
- 生成：doxygen Doxyfile
- 查看：打开 docs/html/index.html；如需PDF，进入 docs/latex 执行 make 生成 refman.pdf
注释规范要点
- 类/接口：/** 简要说明 / 或 /* 详细说明 */ 置于声明前
- 方法：/** 功能说明 \param 参数说明 \return 说明 \throws 异常说明 */
- 字段：/** 字段说明 */
- 支持 @author、@version、@since、@deprecated 等标签

使用Swagger生成RESTful API文档

环境准备
- 安装 JDK 与 Maven：sudo apt update && sudo apt install openjdk-11-jdk maven
Spring Boot集成示例（Springfox）
- 添加依赖（Maven，示例版本）
  - io.springfox:springfox-swagger2:2.9.2
  - io.springfox:springfox-swagger-ui:2.9.2
- 配置类
  - @Configuration @EnableSwagger2
  - 创建 Docket Bean，设置 apis(RequestHandlerSelectors.basePackage(“你的包名”)) 与 paths(PathSelectors.any())
- 访问文档：启动应用后打开浏览器访问 http://localhost:8080/swagger-ui.html
新版接口与替代方案
- Springfox 对 Spring Boot 3 / Spring 6 支持有限，可考虑 springdoc-openapi（基于 OpenAPI 3）：
  - 依赖：org.springdoc:springdoc-openapi-starter-webmvc-ui:2.x
  - 访问：默认 http://localhost:8080/swagger-ui.html 或 /swagger-ui/
无侵入方案（已有OpenAPI/Swagger规范文件）
- 使用 swagger-codegen 生成静态文档站点或客户端代码
  - 下载 CLI：wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.21/swagger-codegen-cli-2.4.21.jar
  - 生成静态站点：java -jar swagger-codegen-cli-2.4.21.jar generate -i openapi.yaml -l static -o /var/www/swagger-ui
  - 用 Nginx 托管静态文件，便于内网访问与发布

如何选择

0 赞

0 踩