关于Javadoc

什么是Javadoc

Javadoc是从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。在编写程序时以/**    */标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档。

如何使用Javadoc

1.运行cmd，找到Java文件存放路径，输入Javadoc 文件名.java。

生成文件列表如下：

javadoc的命令行语法如下：

javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files]

具体用法参照：

http://blog.sina.com.cn/s/blog_5add54780100mlub.html

http://blog.sina.com.cn/s/blog_4a15c3c301000605.html

2.Eclipse中点击Project，选择Generate javadoc。

3.在Eclipse中选中项目，点击右键，选择Export->Export，选择Java下的Javadoc。

 

其中2和3都会弹出一个Generate Javadoc的窗口，其中有两个地方需要注意：

1.Javadoc command：选择jdk下bin/Javadoc.exe。

2.Destination：输出路径。

生成文件列表如下：

 

PS：写博客心得：看似不长的文章写出来也是很麻烦的；研究透彻一个知识需要耐心和时间，而写一篇文章有助于深入研究。