# 一个自动帮你完成JavaDoc注释的IDEA插件

大家好，我是TJ！有段时间没给大家推荐好用工具了，主要是最近工作摸鱼太厉害了，所以也没去探索和接触新东西。

前几天，TJ被领导喷了，原因是代码里注释太少，导致写的SDK在生成JavaDoc文档的时候，有价值的说明内容太少，以后维护不方便。于是马上着实去优化这个是，现在是AI时代了，肯定不能死做，第一反应就是去找找看是否有直接可以用的工具。

于是，我找到了这么个IDEA插件：Easy Javadoc

大家有需要的可以直接打开IDEA，在plugins市场里搜索，就能获得。

在安装完插件之后，您只需要记住下面这些快捷键，然后就可以去代码里自动生成了：

下面跟着动图演示，来体验一下该插件快速生成JavaDoc的能力：

idea javadoc插件

可以看到，它的主要功能就是根据函数名称、参数名称等代码层面的信息，通过翻译，自动生成相关的中文注释。所以，虽然有插件的辅助，但开发者还是要有良好的编码习惯，写能让人看得懂的参数定义、方法定义。这样，后续的其他自动化生成工具就都能完美的用上，来提高我们的工作效率了。

由于该插件会用到翻译功能，所以各位用户还要去选择和配置一下你需要使用的翻译API，每个供应商每月都有免费额度，对于个人来说，都足够使用了，下面是主流的一些翻译API，需要的可以自取：

• 百度翻译申请地址：https://api.fanyi.baidu.com/doc/21
• 腾讯翻译申请地址：https://bianchenghao.cn/document/product/551/7372
• 阿里云翻译申请地址：https://www.aliyun.com/product/ai/alimt
• 有道智云翻译申请地址：https://ai.youdao.com/
• 微软翻译申请地址：https://azure.microsoft.com/
• 谷歌翻译（需要翻墙）申请地址：https://cloud.google.com/

好了，今天的分享就到这里，感兴趣的可以根据下面相关链接了解更多内容：

• 插件地址：https://plugins.jetbrains.com/plugin/12977-easy-javadoc
• 开源项目：https://github.com/starcwang/easy_javadoc

欢迎关注公众号：TJ君，订阅每日推荐，获取更多好用效率工具！

今天的文章
idea javadoc插件分享到此就结束了，感谢您的阅读。