秦疆的Java课程笔记：21 基础 注释

• 平时写代码，代码量比较少的时候还能看懂自己写的，但当项目结构复杂起来，就需要用到注释。

• 注释并不会被执行，是写给写代码的人看的，让别人更容易理解代码。

• 注释是一个非常好的习惯。

• 单行注释

public class HelloWold {  
    public static void main(String[] args) {  
        System.out.println("Hello,World!");  
        //单行注释  
        //输出一个“Hello,World!”
    }  
}

• 多行注释

public class HelloWold {  
    public static void main(String[] args){  
        System.out.println("Hello,World!");  
/*  
多行注释  
或者叫注释块  
输出一个“Hello,World!” 
*/
	}  
}

• 文档注释
  和Javadoc联合使用，可以注释一些参数。

/**  
 * 文档注释  
 * @author Acolyte_9527  
 */
public class HelloWorld {  
    public static void main(String[] args){  
        System.out.println("Hello,World!");  
  
    }  
}

• 注意：
  我在试用文档注释时遭遇了报错：
  Dangling Javadoc comment，悬挂Javadoc注释
  Javadoc文档注释应该有某些规范需要遵守，等待之后学习。
  针对这个报错，具体的原因和解决方案可以参考这篇文档：
  悬挂Javadoc注释

• 神代码注释：一些有趣的图形注释，可以百度到。