【问题标题】:Executing the Eclipse generate javadoc from the command line从命令行执行 Eclipse 生成 javadoc
【发布时间】:2013-08-05 17:16:27
【问题描述】:

我有一个案例,我想通过以下方式生成一个 javadoc。

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

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

看完下面的链接

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

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

我的问题如下,

  • 有没有办法从命令行运行 Eclipse 风格的 Javadoc 生成工具?如果是这样,我在哪里可以找到如何执行此操作的示例。
  • 如果没有办法做到以上几点,有没有办法告诉 javadoc 工具遍历每个包并递归记录其中的类?
  • 有没有办法告诉 javadoc 工具记录什么类型的方法,公共与受保护与等?

【问题讨论】:

    标签: java eclipse cmd


    【解决方案1】:

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

    【讨论】:

      【解决方案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>
      

      【讨论】:

        猜你喜欢
        • 2011-06-03
        • 1970-01-01
        • 2012-07-04
        • 2018-03-02
        • 1970-01-01
        • 1970-01-01
        • 2011-05-05
        • 2012-07-15
        • 2017-07-04
        相关资源
        最近更新 更多