参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用过的jdk版本
- @param 参数名
- @return 返回情况
- @throws 异常情况
示例代码
package base;
/**
* @author test
* @version 1.0
* @since 1.8
*/
public class Doc {
String name;
/**
* @author tetst
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
-
用命令行来生成doc文档
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
-
用idea生成doc文档
-encoding UTF-8 -charset UTF-8 -windowtitle"test"
-encoding是java代码编码,-charset是对生成文档所用的编码。-windowtitle就是对应html的