Javados命令是用来生成自己API文档的
是一种技术,可以将技术信息生成一个帮助文档,是类似于Java的API的
参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
javadoc就是Java生成文档,但有可能我们文档里面有中文,可以把中文设置成编码
javadoc -encoding(编码) UTF -8 -charset UTF -8 Doc.java
UTF -8为编码的格式,charset(字符级)里面字也变成 UTF -8
中间这一堆参数是为了让它多显示一点中文,万一遇到乱码问题就可以解决掉。相当于最开始Java命令然后执行一个文件。现在是用Javadoc命令执行文件,但是加了一堆参数。这个参数是为了让文章显得更优秀,而且不出现乱码,因为中文有些地方识别不到。
package com.xiaoyu.base;
/**
* @author kuangshen
* version 1.0
* since 1.8 这一段注释是加在类上面的
*/
public class Doc {
String name;//类变量 属性
/** 上面是给类加东西,这里是给方法加
*@author kuangshen
* @param name
* @return
* @throws Exception
*/
public String test(String name)throws Exception{
return name;//方法 实例变量
//作业:学会查找使用IDEA生产javadoc文档! 面向百度编程思想!!!
//基础部分的一切知识,后面几乎每天都会用
}
}