本页导航
menu
Javadoc自动填充maven插件
AI摘要
本文介绍了一款用于自动生成Javadoc注释的Maven插件。该插件旨在满足发布到中央仓库的文档要求,支持Java 8和Java 17及以上版本。其核心特性包括模块化设计、灵活的配置选项(如自定义注释范围、排除特定文件等)、完善的错误处理机制以及代码复用。用户可通过配置灵活控制是否为类、方法、参数、返回值和异常等元素生成注释,并能与maven-javadoc-plugin集成使用。
背景
发布到中央仓库时需要javadoc注释,所以写了这个maven插件用于在构建阶段自动生成注释。该插件同时支持Java 8和Java 17版本。
特性
- 同时支持 Java 8 和 Java 17 及以上
- AI 智能生成:支持所有主流 AI 服务提供商
- 多提供商支持:一键切换 OpenAI、DeepSeek、Moonshot、智谱 AI、百度、阿里、Ollama 等
- 环境变量支持:支持从环境变量读取 API Key,避免在 pom.xml 中暴露敏感信息
- 节省 Token:自动跳过已有注释的方法,避免重复生成浪费 token
- 模块化设计:将代码按职责拆分为多个类,提高代码的可维护性和可扩展性
- 降级方案:AI 调用失败时自动降级到规则生成,确保插件稳定运行
安装方法
项目中使用
info
依赖可能非最新版本,请前往maven获取最新版本
在项目的 pom.xml 文件中添加以下依赖
<dependency>
<groupId>io.github.liyao52033</groupId>
<artifactId>autofill-javadoc-maven-plugin</artifactId>
<version>1.3.0</version>
</dependency>
命令行使用
使用环境变量(推荐)
首先导入环境变量
export AI_API_KEY=your-api-key
然后使用
加载中...
