IDE工具和javadoc命令生成API文档

目录

javadoc 命令

1. 通过开发工具生成API文档

1.1 Eclipse生成API文档

1.2 idea生成API文档

2. dos窗口使用 javadoc 命令生成API文档

---

javadoc 命令

javadoc，jdk提供的一个命令。从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。

 

1. 通过开发工具生成API文档

1.1 Eclipse生成API文档

项目右键 → Export → java\javadoc ……

 

1.2 idea生成API文档

Tools → Generate JavaDoc

 

2. dos窗口使用 javadoc 命令生成API文档

javadoc命令格式：javadoc [选项] [软件包名称] [源文件]（javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]）

例如：

       文件：D:\javadoc\User.java  、D:\javadoc\User2.java 

                  D:\javadoc\aa\Function.java

                  D:\javadoc\aaa\Function2.java

        1.User.java 的开发文档：javadocjavadoc\User.java ；

        2.User.java 和Function.java 的开发文档：javadocjavadoc\User.java  javadoc\aa\Function.java

        3.javadoc目录下所以.java文件的开发文档：javadoc javadoc\*.java 

        4.javadoc、aa和aaa 3个文件下的文档：javadoc  javadoc javadoc.aa javadoc.aaa 

        

         注：在D目录下操作的

          包名和路径一致

加上-d asb为：创建文件夹asb，生成的文档会放到这个文件夹下

-private：显示所有类和成员

          若项目编码是 utf-8 为防止出路乱码，可以加入  -encoding utf-8  -charset utf-8

百科：http://baike.baidu.com/view/975838.htm