2009-07-16 56 views
2

我正在使用Netbeans(目前为6.7),我非常喜欢我如何从源代码生成javadoc。但是我的测试也有文档(有价值的文档!)。无论如何,我可以生成javadocs(理想情况下,两者同时)。如何在netbeans中为单元测试生成javadoc

谢谢!

回答

2

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

为什么你不把它们当作普通的Java代码?只需在这个包上运行javadoc,就完成了。

您可以通过Build菜单生成JavaDoc。

祝你好运!

+0

嗨,我不知道你熟悉NetBeans和它的文件夹项目结构。测试保存在与其他源代码不同的目录中,因此您不能只运行'javadoc',我需要知道如何在保存相同包的两个目录上运行javadoc并让javadoc合并它们。另外,Netbeans中没有Build菜单。您可以使用运行菜单为src目录生成javadoc,但我想同时使用src +测试。谢谢! – Mystic 2009-07-20 14:12:33

0

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

+0

我不确定这是否可行。当我知道更多时,我会让你知道。 – 2012-06-09 12:59:03

0

添加以下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引用此目录。)