JavaDoc
package com.steven.demo; import com.sun.org.apache.bcel.internal.generic.ATHROW; /** * @author steven * @version 1.0 * @since 1.8 */ public class JavaDoc { /** * * @param name * @return * @throws Exception */ public String getName (String name) throws Exception{ return name; } }
* javadoc命令是用来生成自己的API文档的
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
生成javadoc文档方式:
1、cmd命令模式:
javadoc -coding UTF-8 -charset UTF-8 JavaDoc.java
这样在目录下面就可以看到生成的一个index.html文件,这就是生成的API文档。
2、IDEA生成javadoc文档:
第一步:
第二步:
1. 选择是整个项目还是模块还是单个文件
2. 文档输出路径
3. Locale 选择地区,这个决定了文档的语言,中文就是zh_CN
4. 传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api