JavaDoc 注释

Question

我用 Maven 创建了一个小的 java 项目。 java文档根据需要包含在 pom.xml 中。

但是当我在另一个项目中使用生成的jar文件时，使用@param等注释所做的评论丢失了。当

Add unimplemented methods (from eclipse)

，参数命名为agr0, arg1, etc...而不是usersame，password.

我不知道在使用 IDE 例如 Eclipse 或 IntelliJ

时应该如何获得正确的 javadoc 文档

我确实添加了 javadoc 插件，如下所示：

<plugin>

            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>

            <executions>
                <!-- JavaDoc Plugin to generate a JAR containing documentation from 
                    the project. -->
                <execution>
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
           </executions>
</plugin>

此致。

Answer 1

如果包含 javadoc，您使用哪个 IDE 并不重要，您应该在将鼠标悬停在已记录的 class/method 或字段上时看到它。我的猜测是你没有包含它，你可以使用 maven-javadoc-plugin 将它添加到你的 pom。

JavaDoc 注释

JavaDoc annotations

java

eclipse

javadoc