javaDoc命令是用来生成自己API文档的
参数信息:
- @auchor:作者名
- @version:版本号
- @since:指明需要最早使用的jdk版本
- @param:参数名
- @return:返回值情况
- @throws:异常抛出情况
//主要生成的参数 如:/*** @author 林伟填* @version 1.0* @since 1.8*/public class doc {String name;/*** @author 卷哥* @param name* @return* @throws Exception*/public String getName(String name) throws Exception{return name;}}
生成JavaDoc文档的两种办法
- 通过cmd来生成
- 1.找到自己的源文件目录地址,如:我的java文件在D:\java\doc\src下
- 2.在这个源文件目录地址下打开cmd,也就是doc系统
- 3.在cmd输入指令生成文档
javadoc (如果代码里有中文我们需要设置编码格式)-encoding UTF-8 -charset UTF-8
源文件.java
- 通过IDEA来生成