1、单行注释 //
//这是main方法,程序的入口
public static void main(String[] args) {
//输出语句
System.out.println("Hello World");
}
2、多行注释 /* */
/*
* print和println区别
*/
【知识点】:多行注释不能再嵌套多行注释
3、文档注释 /** */
【知识点】:常见注释标签。 以下(1)(2)为类标签,(3)(4)(5)为方法标签。
1)@author 用在类中,作者。
2)@version 对类的说明,标明该类的版本。
/**
* @author Gang Ge
* @version V1.0.0
*/
3)@param 对方法中参数的说明
4)@return 对方法返回值的说明
5)@exception 对方法可能抛出的异常进行说明
/**
*
* @param userId 用户ID
* @return 返回用户信息
* @exception 异常
*/
文档注释是可以写入到javadoc文档中的。
命令格式:javadoc -d 文档存放目录 -author -version 源文件名.java
这条命令编译一个名为"源文件名.java"的 java 源文件,并将生成的文档存放在"文档存放目录"指定的目录下,生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。
哪些代码需要注释呢?
1)典型算法必须有注释。
2)在代码不明晰处必须有注释。
3)在代码修改处加上修改标识的注释。
4)在循环和逻辑分支组成的代码中加注释。
5)为他人提供的接口必须加详细注释。