如何为 netbeans 中的单元测试生成 javadoc

Question

我正在使用 Netbeans（当前为 6.7），并且我非常喜欢如何从源代码生成 javadoc。 然而，我的测试也有文档（有价值的文档！）。 无论如何我可以生成javadoc（最好同时生成javadocs）。

谢谢！

Answer 1

JUnit 测试是高效的、正常的 Java 代码。 它们可能包含普通的 JavaDoc 注释。

为什么不把它们当作普通的 Java 代码来对待呢？ 只需对此包运行 javadoc 即可完成。

您可以通过“构建”菜单生成 JavaDoc。

祝你好运！

Answer 2

将以下 Ant 目标添加到 build.xml 对我来说很有效：

    <target depends="init" name="-javadoc-build">
    <javadoc additionalparam="${javadoc.additionalparam}" author="${javadoc.author}" charset="UTF-8" destdir="${dist.javadoc.dir}" docencoding="UTF-8" encoding="${javadoc.encoding.used}" failonerror="true" noindex="${javadoc.noindex}" nonavbar="${javadoc.nonavbar}" notree="${javadoc.notree}" private="${javadoc.private}" source="${javac.source}" splitindex="${javadoc.splitindex}" use="${javadoc.use}" useexternalfile="true" version="${javadoc.version}" windowtitle="${javadoc.windowtitle}">
        <classpath>
            <path path="${javac.classpath}:${javac.test.classpath}"/>
        </classpath>
        <fileset dir="${test.src.dir}" excludes="*.java,${excludes}" includes="${includes}">
            <filename name="**/*.java"/>
        </fileset>
        <fileset dir="src/try" excludes="*.java,${excludes}" includes="${includes}">
            <filename name="**/*.java"/>
        </fileset>
        <fileset dir="${src.dir}" excludes="*.java,${excludes}" includes="${includes}">
            <filename name="**/*.java"/>
        </fileset>
        <fileset dir="${build.generated.sources.dir}" erroronmissingdir="false">
            <include name="**/*.java"/>
            <exclude name="*.java"/>
        </fileset>
    </javadoc>
    <copy todir="${dist.javadoc.dir}">
        <fileset dir="${src.dir}" excludes="${excludes}" includes="${includes}">
            <filename name="**/doc-files/**"/>
        </fileset>
        <fileset dir="${build.generated.sources.dir}" erroronmissingdir="false">
            <include name="**/doc-files/**"/>
        </fileset>
    </copy>
</target>

它是从 nbproject/build-impl.xml 复制的，并进行了三处更改：

• 将 classpath 扩展为 "${javac.classpath}： ${javac.test.classpath}"
• 添加一个 fileset 元素，其中 dir="${test.src.dir}" 有正常的 netbeans < em>“测试包”
• 添加一个 fileset 元素，其中 dir="src/try" 这是我的项目使用的额外源目录。 （我不知道如何使用像 ${test.src.dir} 这样的变量来引用这个目录。）

Answer 3

在 Build-impl.xml 中有一个名为“-javadoc-build”的目标。 它包含两个“文件集”部分。 也许可以在这里添加第三部分。