注释
注释的三种方式
单行注释:// 多行注释:/* */ 文档注释:/** */,该方法可以多行。使用该方法注释的内容会被解释成程序的正式文档,并能包含进如javadoc工具生成的文档里,用以说明该程序的层次结构及其方法。
javadoc使用
-
支持的字段
/**
* @author 作者
* @version 1.0
* @since 1.8
* @param
* @return
* @throws
*/ -
示例代码
/**
* @author 作者
* @version 1.0
* @since 1.8
* @param
* @return
* @throws
*/
public class application {
public static void main(String[] args){
int a=10;
int b=20;
System.out.println(""+a+b); //输出1020
System.out.println(a+b+""); //输出30
}
}
class Doc{
private String name;
/**
* @param name
* @return
* @throws Exception
*/
public String getName(String name) throws Exception{
return name;
}
} -
在cmd命令行下运行:
javadoc -encoding UTF8 charset UTF8 application.java
-
使用浏览器打开生成的index.html
-