一、单行注释
- 说明:用“//”来标记
- 示例:
public class Demo1 {
public static void main(String[] args) {
//注释
System.out.println("hello world");
}
}
二、多行(块)注释
- 说明:用“/* */”来标记
- 示例:
public class Demo1 {
public static void main(String[] args) {
/*这
* 是
* 一
* 个
* 多
* 行
* 注
* 释*/
System.out.println("hello world");
}
}
三、文档注释(JavaDoc)
- 说明:用“/** */”来标记
常用的doc参数有:
@author 作者名
@version 版本号
@since 说明需要最早使用的jdk版本
@param 说明方法中的参数
@return 说明方法的返回值
@throws 说明异常抛出情况 - 示例:
/**
* @author 某某某
* @version 1.0
* @since 1.8
*/
public class Demo1 {
String name;
/**
* @author 某某某
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}