Как создать Javadoc для модульных тестов в NetBeans - PullRequest
Новая
       20

Как создать Javadoc для модульных тестов в NetBeans

2 голосов
/ 17 июля 2009

Я использую Netbeans (в настоящее время 6.7), и мне действительно нравится, как я могу генерировать Javadoc из моего исходного кода. Однако мои тесты также имеют документацию (ценная документация!). Есть ли в любом случае я могу генерировать Javadocs (в идеале для обоих одновременно).

Спасибо!

Ответы [ 3 ]

2 голосов
/ 17 июля 2009

Тесты JUnit - это продуктивный обычный код Java. Они могут содержать обычные комментарии JavaDoc.

Почему бы вам не относиться к ним как к нормальному Java-коду? Просто запустите javadoc над этим пакетом, и все готово.

Вы можете создать свой JavaDoc через меню Build.

Удачи!

0 голосов
/ 10 июня 2012

Добавление следующей цели 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} для ссылки на этот каталог.)
0 голосов
/ 09 июня 2012

В Build-impl.xml есть цель с именем "-javadoc-build". Он содержит два раздела «набор файлов». Возможно, здесь можно добавить третий раздел.

...