java中的注释是为了方便自己和后人阅读代码而写的。就算是自己写的,时间长了也会忘记,所以代码注释是很重要的,这样也会是你的代码显得更规范。
注释一般分为,写代码前的注释,写代码中的注释,写完代码后的注释。
写代码前,一般将代码的作者和需求写到注释里面,
写代码中,中间定义的变量、应用的对象等需要用注释表明,为的是知道变量都是什么意思,
写完代码后,需要对代码进行注释的补充,之前来不及写的,忘记写的给它补充完整。
java中的注释有三种形式:单行注释,多行注释(又叫块注释),文档注释。
• 单行注释以 // 开始,没有结束,注释的内容一定要在一行,不能跨行。
System.out.println("hello world!"); //在控制台打印输出"hello world!"
• 多行注释以 /* 开始,以 / 结束,不能嵌套
/ * 这是我的第一个程序!
- 在控制台打印输出"这是我的一个简单的程序!"
*/
class Demo1{
public static void main(String[] args) {
System.out.println("这是我的一个简单的程序!");
}
}
• 文档注释以 /** 标记开始,最后以 / 标记结束。主要用于以后用javadoc工具,生成html文档说明,以方便使用阅读。一般用于类之前。
/* * @ClassName: FirstProg
- @Description: TODO(这里用一句话描述这个类的作用)
- @author Sergio Han * @date 2014-7-15 上午9:47:01
- 这是第一个小程序!文档注释 */
class Demo1{
public static void main(String[] args) {
System.out.println("这是我的一个简单的程序!");
}
}