`

javadoc命令

    博客分类:
  • Java
 
阅读更多
以下内容引用自(原文更全):http://hi.baidu.com/%B1%CA%C3%FB%D3%F1%CA%F7%B7%E7/blog/item/412048dab8e4102c32fa1c44.html
引用

假设源代码在 C:src 目录下,其中 com.liigo 是主包,其下可能有数十个子包,数百(千)个Java文件。目录结构大约是这样的:

- C:
    | src
      | com
        | liigo

           | ***

怎么才能以最简捷的方式生成所有的API文档呢?

c:>
c:>cd src
c:src>javadoc -d doc -subpackages com.liigo

这样就搞定了,最终生成的API文档位于 c:srcdoc 目录(该目录是由javadoc.exe自动生成的)。

上面的用法利用了“当前目录”和“相对路径”,当然也可以用绝对路径:

...>javadoc -d c:doc -sourcepath c:src -subpackages com.liigo

最终生成的API文档位于 c:doc 目录(该目录同样是由javadoc.exe自动生成的)。


总结一下:

我们只用到了javadoc的三个参数: -d,-subpackages,-sourcepath,其中:

参数 说明
-d 指定API文档的输出目录,默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径,默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数!如果不使用本参数,每次只能处理一个子包(或需手工列出所有子包)。
分享到:
评论

相关推荐

    用javadoc命令生成api帮助文档

    用javadoc命令生成api帮助文档,如果要学习的话,少了帮助文档哪能行,于是就用javadoc命令自己制作了一个。

    JavaDoc命令使用说明.pdf

    JavaDoc命令使用说明.pdf

    gradle-javadoc-checker-master

    利用 javadoc 命令工具的 tools.jar 进行自定义 doclet 操作,然后生成自定的 doc 进行解析判断。 具体参见 oracle 官方文档: javadoc doclet javadoc tools 使用介绍 插件默认使用操作如下: apply plugin: '...

    Javadoc详细讲解以及生成方式

    Javadoc的详细文档以及生成的方式(AndroidStudio、Eclipse、Javadoc命令)

    导出javadoc

    so disney! 教你如何通过java 导出jni

    JavaDoc使用方法

    javadoc利用Java编译程序javac对程序代码源文件中的声明和文档注释进行语法分析,并在默认情况下...这样当涉及类和内部类的有关描述时,是否正确地设置了classpath变量可能会影响到javadoc命令是否可以完全成功执行。

    zxing-core-javadoc文件

    zxing-core-javadoc文件,版本:3.3.2,javadoc命令是用来生成自己API文档的

    commons-collections4-4.1-javadoc

    commons-collections4-4.1-javadoc 程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助...javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。

    java代码知识点总结

    JAVA知识点汇总 必须养成优秀程序员的编写习惯:缩进(用空格)、注释、命名约定。 大小写敏感。... 使用javadoc命令建立HTML格式的程序文档: javadoc[options][packagenames][sourcefiles][@files]

    androidjava源码-gradle-javadoc-checker:一个检查android、androidLibrary、java、ja

    命令工具的 tools.jar 进行自定义 doclet 操作,然后生成自定的 doc 进行解析判断。 具体参见 oracle 官方文档: 使用介绍 插件默认使用操作如下: apply plugin: 'javadoc.checker' buildscript { repositories { ...

    java期末考试试题(3)

    2.下面哪种注释方法能够支持javadoc命令: A /**...**/ B /*...*/ C // D /**...*/ 3. 欲编写如下图的一个界面,用于显示用户指定的图像: 如果在区域A中只能放置一个AWT组件,从各组件的本来功能角度考虑,最好...

    JAVA--达内培训笔记

    文档注释/** ........(换行标签)*/,用javadoc命令可以根据原码中的文档注释生成注释文档(html格式)。文档注释中可以使用html标签。 javadoc -d 路径(指定注释文档的保存路径) xxx.java 文档注释一般写在类...

    2Java SE(上).doc

    文档注释可以被javadoc命令所解析并根据内容生成手册 2. 字符串是不变对象:字符串对象一旦创建,内容是不可改变的,要想改变内容一定会创建新对象。 字符串若使用字面量形式创建对象,会重用以前创建过的内容...

    【02-数据类型与运算符】

     •文档注释还可以通过javadoc 命令来生成API文档  •格式: javadoc –d apidoc 源文件名  –其中-d path指定存放API文档的路径。  •API 文档包括三个区域分别是:包区域,类区域,详细说明区域 注: 如果要...

    java8rt.jar源码-java8-features:java8-功能

    Javadoc 命令 1 $ javadoc -d /Users/nsa/Documents/eclipseWorkspace_2018_09/java8/html2 -sourcepath /Users/nsa/Documents/eclipseWorkspace_2018_09/java8/src/main/java -subpackages 功能 Javadoc 命令 2 $...

    maven中下载jar包源码和javadoc的命令介绍

    主要介绍了maven中下载jar包源码和javadoc的命令介绍,本文讲解了Maven命令下载源码和javadocs、通过配置文件添加、配置eclipse等内容,需要的朋友可以参考下

    Java编译运行、反编译、制作javadoc工具

    一个用Java写的小工具,用于Java编程的编译运行、反编译calss文件和制作Javadoc文件,不需要在命令提示符下输入命令

    125集专攻JAVA基础 JAVA零基础入门学习视频教程 动力节点JAVA视频教程.txt

    北京动力节点-Java编程零基础教程-033-Java基本语法-注释-javadoc命令.avi 北京动力节点-Java编程零基础教程-034-Java基本语法-标识符.avi 北京动力节点-Java编程零基础教程-035-Java基本语法-关键字.avi 北京...

    java-design-patterns:Java 中大多数 GoF 设计模式的工作示例

    Java设计模式 以下存储库包含 GoF 设计模式的 Java 实现。 示例取自以下书籍。 概念 src 目录中提供了以下所有经典 Java 设计模式... 源代码示例的 javadoc 可以通过克隆存储库或下载源代码并运行 javadoc 命令来生成。

    junit-4.10-javadoc.jar.zip

    java jar包,亲测试可用 安全,可以对其进行数字签名,只让能够识别数字签名的用户使用里面的东西。 加快下载速度; 压缩,使文件变小,与...通常使用jar命令来压缩,可以把一个或多个路径全部压缩成一个JAR文件。

Global site tag (gtag.js) - Google Analytics