spring - 在 Gradle API 项目中将 Maven 项目作为模块导入时丢失 Javadoc 注释

Question

我有一个 Gradle Spring Boot API 项目和另一个 Maven 项目，我将它们作为工件构建到 .jar 文件中，并作为模块导入我的 API 项目。之后，一切正常，但是当我查看 API 项目中的方法时，我在 Maven 项目中为所有服务和方法所做的 Javadoc 注释没有被保留。有没有办法将 Javadoc 注释带到 API 项目中？

标签： springspring-bootrestmavengradle

Answer 1

经过一番研究，我想出了一个方法来做到这一点。把它贴在这里，以防其他人需要帮助。

首先，您需要在项目中添加一个 Javadoc 插件（这将为 Javadoc 创建一个 .jar 文件），该插件应该被打包成一个 .jar 文件以导入另一个项目。

在需要导入 *.jar 文件的项目中：转到文件 -> 项目结构 -> 模块（在侧面导航栏中）-> 依赖项 -> 找到您导入的想要附加 Javadoc 的 .jar - >右键单击然后“编辑”

将打开一个新窗口，如果您的 Javadoc 是 *.jar 文件，请单击“+”按钮，然后找到 *.jar 将其添加到那里。如果是链接，则添加链接符号并插入链接。

这应该在模块 *.jar 文件和它的 Javadoc *.jar 文件之间建立连接，这还可以在将鼠标悬停在方法的实例上时在快速预览中启用对导入的方法和类的描述（来自 Javadoc）。

参考：https ://stackoverflow.com/a/91514/15743238