javadoc 的基本使用

准备工作

1.java开发环境的安装

安装Java JDK，

电脑是32位的：http://rj.baidu.com/soft/detail/10463.html?ald (百度软件，呵呵)

          64位的：http://www.java.com/zh_CN/download/win10.jsp (java官网)    

                     ：http://www.oracle.com/technetwork/indexes/downloads/index.html#java (oracle官网  更全需要的自己找)

检查：运行--> cmd --> java -version 查看

2.查看javadoc.exe路径

在安装的路径下查看是否有javadoc.exe文件(在java的JDK的文件夹下)

默认安装路径 C:\Program Files\Java\jdk1.8.0_40\bin\javadoc.exe （1.8.0_40是我的jdk版本号）

使用（两种方法）

1.工具

一种eclipse的使用方法（android studio应该差不多，我的电脑跑不动，暂时没有试）

<转>  http://blog.csdn.net/nothing0318/article/details/7258523

2.cmd命令

<转> http://jingyan.baidu.com/article/2c8c281df777d90008252aff.html

注意：如果直接按照上面网址中提到的输入：

javadoc HelloDate.java

会出现下面的错误提示：

正在加载程序包HelloDate.java的源文件...

javadoc: 警告 - 没有程序包HelloDate.java的源文件

正在构造 Javadoc 信息...

javadoc: 警告 - 没有程序包HelloDate.java的源文件

javadoc: 错误 - 找不到可以文档化的公共或受保护的类。

1 个错误

2 个警告

怎么回事：javadoc 默认执行的目录是  javadoc.exe评级的目录，也就是说要将 执行的.java文件,放入到

你的安装jdk的路径下(C:\Program Files\Java\jdk1.8.0_40\bin\)， 这样不好，可能导致jdk的路径下

的文件混乱。

怎么办： 输入  javadoc  全路径\HelloDate.java 

可是接下来还是会报错：   

C:\Program Files\Java\jdk1.8.0_40\bin>javadoc D:\workspace\Testjavadoc\src\javadoctext\*

正在加载源文件D:\workspace\Testjavadoc\src\javadoctext\HelloDate.java...

正在加载源文件D:\workspace\Testjavadoc\src\javadoctext\TestJavadoc.java...

正在构造 Javadoc 信息...

标准 Doclet 版本 1.8.0_40

正在构建所有程序包和类的树...

javadoc: 错误 - could not create parent directories

1 个错误

这句话意思：could not create parent directories，没法创建父目录

怎么回事：javadoc 执行后，目标文件默认生成在javadoc.exe的同目录下，在win 7以上好像有权限要求。

怎么办： 输入  javadoc  -d  D:\text  D:\workspace\Testjavadoc\src\javadoctext\*

意思是：将执行后的目标文件生成在D盘的text的文件夹下

我的HelloDate.java文件在javadoctext的包下，其中还有TestJavadoc.java的文件，一起生成用到了   \* 

参考：

命令使用 <转> 自己多试试

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

注释规范<转> 不是很详细，基本的

http://blog.csdn.net/shiyuezhong/article/details/8205281

原文链接：http://www.apkbus.com/blog-610699-59449.html