Java学习笔记

C风格注释
你可以把注释内容写在/* /里，可跨多行，一旦标记了/，它遇到下一个*/就会结束注释。
单行注释
你可以把注释内容写在//标记之后，知道本行结束，不可跨多行。
用于提取文档的注释（注释文档）
Java提供了Javadoc机制从源码的注释中提取和生成html文档，不过这个注释要符合特定格式，
用于提取文档的注释以/开头，以/结束。这样的注释也可跨多行，注释间每行开始如果有一个*或任意空白都可被忽略，为了更方便的提取文档，可以在这种注释里直接加入html代码，比如：
/*
*具体类信息可以到这里查找


/
把这段注释文档放在某个你想注释的类，字段 或者 方法前面一行，再用javadoc提取文档你就能看到你对这个类/字段或者方法的注释，后面我们会提到，只能对标记为public或protect的类/域/方法做注释。
也可以通过@符号加一些标记让javadoc快速自动帮你生成符合情境的html文档，比如：
/
*@author TiriSane
*/
提取文档后，这个注释对应的类/域/方法介绍上会有作者这一项。除了author还有很多标记可以用：
@see 类名
@see 类名#类成员名
@see可以在你介绍一个类成员时，链接到其他类/类成员的文档。

  {@link 类名#类成员名 你想要显示的标签名}
  @link作用类似域@see，不过文档中超链接处会显示标签名而不是类名。
  
   @version
   用于说明版本信息。
   
   @since
   用于说明代码使用JDK的最早版本，比如@since JDK 1.8
   
   @author
   用于说明作者信息。

   @param 参数名 描述
   带@param的注释需放在一个类方法之前，用于说明这个方法的其中一个参数的意义。

   @return 描述
   带@return的注释需放在一个类方法之前，用于说明这个方法的返回值。

    @throws 异常类 异常说明
   目前还没讲到异常，简言之，就是用来 放在方法前 描述这个方法在何种情况下可能会产生这种异常。

    @deprecated
    用于指出注释文档所注释的类/域/方法是过时的，下个版本可能就删掉了，建议使用你代码的人不要使用这个标记的类/域/方法。

    {@docRoot}
    这个标签往往配合一些注释文档里的html代码使用，指出了文档的根目录，是一种相对路径标记。
    
    {@inheritDoc}
    这个标记所在的注释文档要放在类前面，生成javadoc时会把它的直接继承类的注释复制到这个类里。