JavaDoc生成文档
简介
- javadoc命令是用来生成自己API文档的
- 参数信息
- @ author 作者名
- @ version 版本号
- @ since 指明需要最早使用的jdk版本
- @ param 参数名
- @ return 返回值情况
- @ throws 异常抛出情况
package com.jack.base;
/**
* @author Jack丶wang
* @version 1.0
* @since 1.8
*/
public class Doc {
String name;
/**
* @author name
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
使用命令行生成JavaDoc文档
格式:javadoc 参数 Java文件
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
// -encoding编码,-encoding UTF-8编码,格式为UTF-8
// -charset编码,-charset UTF-8将字符集进行编码,格式为UTF-8
命令行显示如下:
使用IDEA生成JavaDoc文档
- 第一步
- 第二步
-
选择是整个项目还是模块还是单个文件
-
文档输出路径
-
Locale 选择地区,这个决定了文档的语言,中文就是zh_CN
-
传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api
- 可以看到控制台的输出
- 然后找到生成的html
- 看一下效果