java文件使用命令生成doc文档
JavaDoc
1.javadoc命令是用来生成自己API文档的
参数信息
-
@author作者名
-
@version版本号
-
@since指明需要最早使用的jdk版本
-
@param参数名
-
@return返回值情况
-
@throws异常抛出情况
package com.liu.cn;
/**
* @author 余人
* @version 1.0
* @since 1.8
*/
public class Doc {
String name;
/**
* @author 余人
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
进入文件目录
cd D:\eclipse编写\aaa\src\com\liu\cn
输入命令
javadoc -encoding UTF-8 Doc.java
找到目录进入index.html:
生成如下图doc文档