吾心安处即吾乡。吾乡何处不可眠

1. 什么是注释？

• 源文件中用于解释、说明程序的文字就是注释。

• 注释是一个程序员必须要具有的良好编程习惯。实际开发中，程序员可以先将自己的思想通过注释整理出来，再用代码去体现。

  程序员最讨厌两件事：

  一件是自己写代码被要求加注释

  另一件是接手别人代码，发现没有注释

• 不加注释的危害

• Java中的注释类型：

  • 单行注释

    //注释文字
    

  • 多行注释

    /* 
    注释文字1 
    注释文字2
    注释文字3
    */
    

  • 文档注释 (Java特有)

    /**
      @author  指定java程序的作者
      @version  指定源文件的版本
    */ 
    

2. 注释的作用

• 它提升了程序的可阅读性。（不加注释的危害性，见图。）
• 调试程序的重要方法。

3. 具体使用1：单行注释、多行注释

• 对于单行和多行注释，被注释的文字，不会不会出现在字节码文件中，进而不会被JVM（java虚拟机）解释执行。

• 多行注释里面不允许有多行注释嵌套。

• 一个段子

  A：嘿 //是什么意思啊？
  B：嘿.
  A：呃 我问你//是什么意思？
  B：问吧.
  A：我刚才不是问了么？
  B：啊？
  A：你再看看记录...
  B：看完了.
  A：......所以//是啥？
  B：所以什么？
  A：你存心耍我呢吧？
  B：没有啊 你想问什么？
  ……
  不断循环之后，A一气之下和B绝交，自己苦学程序。
  N年之后，A终于修成正果，回想起B，又把聊天记录翻出来看，这时，他突然发现B没有耍他……
  而他自己也不知道当年他问B的究竟是什么问题……
  

4. 具体使用2：文档注释（Java特有）

• 文档注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。

• 操作方式。比如：

  javadoc -d mydoc -author -version HelloWorld.java
  

案例：

//单行注释
/*
多行注释
*/
/**
文档注释演示。这是我的第一个Java程序！^_^
@author songhk
@version 1.0
*/
public class HelloWorld{
    
	/**
	Java程序的入口
	@param args main方法的命令参数
	*/
    public static void main(String[] args){
        System.out.println("hello");
    }
}