JavaDoc
JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过 Javadoc就可以同时形成程序的开发文档了。
1、文档注释样例
文档注释样例:
public class Doc {
public String name;
/**
* @param name 姓名
* @return 返回name姓名
* @throws Exception 无异常抛出
* */
public String function(String name) throws Exception{
return name;
}
}
以 /* 开始,以 / 结束。
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
2、生成doc(方法是使用命令行)
1.打开文件所在位置
2.打开命令行
再文件路径前输入cmd空格,在此路径打开cmd命令行
3. 输入生成 Doc 的代码
javadoc -encoding UTF-8 -charset UTF-8 自己要生成doc的文件名.java
只要没报错就意味着成功生成,警告不用管
-encoding UTF-8 -charset UTF-8是为了解决中文乱码问题
4.点击打开生成的html文件