/** //在类前面敲/**显示文档信息如下
* @authout yan //然后写@authout (作者)
* @version 1.0 //@version(版本)
* @since 1.8 //@since(最早使用的JDK版本)
*/
public class Doc {
String name;
/** //在类里面,方法的前面敲/**+(回车)会自动显示如下信息
* @author yan
* @param name //参数名
* @return name
* @throws Exception //会抛出的异常
*/
public String test(String name) throws Exception/*会抛出的异常*/{
return name;
}
}
然后
在文件夹的位置打开
在文件夹中打开doc命令 输入
javadoc为生成doc文本的语句 -encoding UTF-8 -charset UTF-8是为了让路径中可能存在的中文更清晰的显示 Doc.java是用来生成doc文件的文件
运行出来
打开index.html
用idea生成doc文档
点击此处跳转到教学blog