JavaDoc
javadoc命令是用来生成自己API文档的
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
package com.zhong.base
/**
*@author zhonng
*@version 1.0
*@since 1.8
*/
public class Doc{
String name; //属性
/**
*@param name
*@return
*@throws Exception
*/
//可以自己添加
public String test(String name)throws Exception{
return name; //这两行代码是方法
}
public static void main(String [] args){
System.out.println("hello,world!");
}
}
这段代码为了文档中多出现代码
javadoc :java生成文档
-encoding UTF-8 编码为UTF-8
-charset UTF-8 文档里的字也变成UTF-8
最后的Doc.java 是为了把下面的代码编译成一份可阅读的中文文档
通过命令行 Javados 参数 Java文件 生成java文件