【亲测免费】 Easy Javadoc 插件常见问题解决方案

项目基础介绍

Easy Javadoc 是一个为 IntelliJ IDEA 开发的插件，旨在帮助 Java 和 Kotlin 开发者自动生成 javadoc 和 kdoc 文档注释。该插件支持多种 IDEA 版本，从 2019.1 及以上版本均可使用。它不仅能够自动生成文档注释，还支持中文命名生成、多种翻译接口接入、自定义映射等功能，极大地提高了开发效率。

新手使用注意事项及解决方案

1. 快捷键冲突问题

问题描述：在使用 Easy Javadoc 插件时，可能会遇到快捷键不生效的情况，这通常是由于与其他插件或 IDEA 自带功能的快捷键冲突导致的。

解决步骤：

1. 检查快捷键设置：打开 IntelliJ IDEA，进入 File -> Settings -> Keymap，搜索 Easy Javadoc 相关的快捷键（如 Ctrl \ 或 Command \）。
2. 修改冲突快捷键：如果发现冲突，可以右键点击冲突的快捷键，选择 Remove 或 Change Shortcut 来解决冲突。
3. 重启 IDEA：修改完成后，重启 IntelliJ IDEA 以确保设置生效。

2. 属性单行注释不生效

问题描述：在生成属性注释时，可能会遇到单行注释不生效的问题，这通常是由于 IDEA 的默认格式化设置导致的。

解决步骤：

1. 修改格式化设置：打开 IntelliJ IDEA，进入 File -> Settings -> Editor -> Code Style -> Java。
2. 调整注释格式：在 Code Generation 标签下，找到 Comment Code 部分，确保 Line comment at first column 和 Block comment at first column 选项被勾选。
3. 应用并重启：点击 Apply 并重启 IDEA，确保设置生效。

3. 文档标签顺序不对

问题描述：生成的文档注释中，@param、@link 等标签的顺序可能不符合预期，这通常是由于 IDEA 的默认格式化设置导致的。

解决步骤：

1. 修改文档标签顺序：打开 IntelliJ IDEA，进入 File -> Settings -> Editor -> Code Style -> Java。
2. 调整文档注释格式：在 Code Generation 标签下，找到 Comment Code 部分，确保 Doc Comment -> General 中的 Add a blank line after description 和 Add a blank line before tags 选项被勾选。
3. 应用并重启：点击 Apply 并重启 IDEA，确保设置生效。

通过以上步骤，新手用户可以更好地解决在使用 Easy Javadoc 插件时遇到的一些常见问题，从而更高效地进行文档注释的生成和管理。