javadoc动作中排除某些类

设计产品的类结构时，有些类的作用是与产品的其他部分交互，因此必须是public类型的，但又不希望暴露给用户，因此打产品包的javadoc时，这些类是不生成javadoc的。假设某个包里共有10个接口，其中有一个是不生成javadoc的，写出另外9个接口名显然是很dirty的方法，比较好的方法是定义一个exclude，例如：

<javadoc sourcepath="${src.dir}" destdir="${build.javadoc.dir}"

    encoding = "GBK" docencoding = "GBK"

    packagenames ="com.boco.godu.gapi.exception" >

    < sourcefiles >

       < fileset dir="${src.dir}/com/boco/godu/gapi">

           <include name="*.java"/>

           < exclude name="IConnPool.java"/>

       </fileset>

    </ sourcefiles >

</javadoc>

上面的例子表明，对于整个包（package）统一生成javadoc的，采用的内嵌的packagenames定义（可以用逗号隔开多个包名），对于需要exclude的包，用+定义，可以非常方便的使用exclude功能。

javadoc动作中排除某些类

Published

Last Updated

Category

Tags

Contact