在 Intellij IDEA 中附加额外的 javadoc,您可以使用插件 Javadoc-Tools
。这个插件允许在 IDEA 中生成 Javadoc 并将其附加到类和方法中。以下是如何在 Intellij IDEA 中添加这个插件的方法。
安装 Javadoc-Tools 插件
在启动 Intellij IDEA 后,点击 "Create New Project" 或者 "Open Project" 按钮,然后选择要编辑的项目。
在顶部搜索框中输入 "Javadoc",然后在下拉菜单中选择 "Javadoc-Tools"。点击此插件名称并点击 "Install Plugin"。
打开插件并配置 Javadoc 输出
在成功安装插件后,打开 IntelliJ IDEA
> Preferences
(或者通过快捷键 "Mac: cmd + ," / "Windows: Ctrl + S") > 点击
Plugins,然后选择
Javadoc-Tools`。
点击左下角的 New Javadoc Folder
然后选择项目内的文件夹。如果已经存在了某个文件夹,请点 Edit
以编辑现有文档。
点击 Additional Javadoc Links
> Add...
> 浏览到 您的项目的
build目录
(例如 build/classes/java/main) > 点击 Filesystem...
> 在文件系统浏览窗口中找到您的 Java
文件,勾选您希望在此 Javadoc 中生成的文件(默认勾选类、接口和方法。)。
如果您希望在类和方法上附加 Javadoc,则确保选中右侧的复选框。
点击 OK
按钮保存更改并且重新打开项目。
现在,您的 Intellij IDEA 项目中应该会显示由 Javadoc-Tools
插件生成的附加 Javadoc 链接。您还可以从此插件生成 Markdown 或 HTML 格式的 Javadoc 文档。
领取专属 10元无门槛券
手把手带您无忧上云