Question

我正在使用Netbeans（目前是6.7），我真的很喜欢如何从源代码生成javadoc。但是我的测试也有文档（有价值的文档！）。无论如何，我可以生成javadocs（理想情况下，两者同时）。

谢谢！

Answer 1

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

为什么不像普通的Java代码那样对待它们？只需在此软件包上运行javadoc即可完成。

您可以通过Build Menu生成JavaDoc。

祝你好运！

Answer 2

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

Answer 3

将以下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 “测试包”
添加fileset元素dir="src/try"这是我的项目使用的额外源目录。 （我不知道如何使用像$ {test.src.dir}这样的变量来引用这个目录。）

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

3 个答案: