用于 eclipse 中新 java maven 项目的 Javadoc
Javadoc for a New java maven project in eclipse
我新建了一个Maven项目,通过eclipse生成了Javadocs。它在名为 "doc" 的文件夹内的项目目录中创建了很多 html 文件。
现在我想把这个项目作为依赖分发给我的同事,他没有我创建的项目的源代码。他只是将我的项目添加为依赖项。他说,当他将鼠标悬停在我在我的项目中创建的方法上时,他看不到 javadoc。
我在这里错过了什么?
添加 maven-javadoc-plugin to the project (plugins section of your pom.xml), instead of generating the Javadocs through Eclipse. Please have a look at the jar 目标。如果正确完成,Maven 构建将在普通 jar 文件旁边打包一个 javadoc jar。构建将生成以下 jars:
- ${artifactId}-${version}.jar
- ${artifactId}-${version}-javadoc.jar
如果您想额外提供源代码,maven-source-plugin(目标 jar)将为您完成这项工作。
可以使用 maven-install-plugin.
将 jar 文件、javadoc 文件以及源文件安装到您同事的本地 Maven 存储库中
我新建了一个Maven项目,通过eclipse生成了Javadocs。它在名为 "doc" 的文件夹内的项目目录中创建了很多 html 文件。 现在我想把这个项目作为依赖分发给我的同事,他没有我创建的项目的源代码。他只是将我的项目添加为依赖项。他说,当他将鼠标悬停在我在我的项目中创建的方法上时,他看不到 javadoc。
我在这里错过了什么?
添加 maven-javadoc-plugin to the project (plugins section of your pom.xml), instead of generating the Javadocs through Eclipse. Please have a look at the jar 目标。如果正确完成,Maven 构建将在普通 jar 文件旁边打包一个 javadoc jar。构建将生成以下 jars:
- ${artifactId}-${version}.jar
- ${artifactId}-${version}-javadoc.jar
如果您想额外提供源代码,maven-source-plugin(目标 jar)将为您完成这项工作。
可以使用 maven-install-plugin.
将 jar 文件、javadoc 文件以及源文件安装到您同事的本地 Maven 存储库中