执行Eclipse会从命令行生成javadoc

Question

我有一个案例，我希望以下列方式生成一个javadoc。

• 我想为整个项目的公共方法生成javadoc
• 我想为单个类的受保护方法生成一个javadoc。

使用Eclipse中的Generate Javadoc工具非常容易，但是已经要求在这种情况下生成Javadoc使用命令行或批处理脚本而不是Eclipse GUI。

阅读以下链接后

http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#runningjavadoc

我理解如何从命令行使用javadoc工具，但它没有告诉我如何选择要记录的方法类型，而且似乎我必须列出每个类。

我的问题如下，

• 有没有办法从命令行运行Eclipse样式的Javadoc生成工具？如果是这样，我在哪里可以找到以及如何执行此操作的示例。
• 如果没有办法执行上述操作，是否有办法告诉javadoc工具遍历每个包并以递归方式记录类？
• 有没有办法告诉javadoc工具要记录什么类型的方法，public vs protected vs？

Answer 1

你可以让eclipse生成一个ant build文件。然后，您可以从命令行使用此ant构建文件。

Answer 2

从javadoc帮助文本中可以使用这些标志/参数：

-public                   Show only public classes and members
-protected                Show protected/public classes and members (default)
-package                  Show package/protected/public classes and members
-private                  Show all classes and members
-help                     Display command line options and exit
-doclet <class>           Generate output via alternate doclet
-docletpath <path>        Specify where to find doclet class files
-sourcepath <pathlist>    Specify where to find source files
-classpath <pathlist>     Specify where to find user class files
-exclude <pkglist>        Specify a list of packages to exclude
-subpackages <subpkglist> Specify subpackages to recursively load

或者，您可以使用像ant或maven这样的构建工具为您生成具有良好包装函数的javadoc。这是我的一个项目的ant javadoc目标：

<target name="javadoc" description = "generate javadoc from source">
    <delete dir="javadoc" verbose ="true"/>
    <javadoc packagenames ="my.app.*"               
            sourcepathref = "javadoc.sourcepath"
            author ="true"
            destdir = "javadoc"
            windowtitle = "${project-name} API"
            linksource= "yes"
            overview="${src}/overview-summary.html"
        access="public">                    



    </javadoc>
    </target>