您的位置:首页 > 编程语言 > Java开发

javadoc生成开发文档

2015-12-22 15:57 501 查看
Javadoc:从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。

一、Eclipse生成开发文档:项目右键 → Export →
java\javadoc ……

二、dos 命令生成开发文档

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://blog.chinaunix.net/uid-725717-id-2060139.html

百科:http://baike.baidu.com/view/975838.htm
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: