Java注释学习

初次写博客……

学习了一段时间的Java了，以前不太重视注释。总感觉写注释没有太大的作用。后来和别人一起写代码才发现，注释不仅是代码的说明，也是一种沟通。写好注释可以让你对整个程序有足够的清晰的认识，而且也方便了别人对你的代码的理解。注释是一种习惯，就像写优美的、高效的代码一样。当你去足够的正视这些的时候，编程不再是一份工作或者一种喜爱，而是一门艺术。
注释方式：
行级注释：// 内容
多行注释：/* 内容 */
文档注释：/** 内容 */
注释的插入：

• 包
• 公有类与接口
• 公有的和受保护的构造器及方法
• 公有的和受保护的域

详解：
通用注释：
@author 姓名：标记将产生一个“author”（作者条目）每一个@author标记对应一名作者。
@version 文本：标记将产生一个”version”(版本)条目，对当前版本的任何描述。
@since 文本：标记将产生一个“since”（始于）条目，对引入特征的版本描述。
@deprecated 文本：这个标记将对类、方法和变量添加一个不再使用的注释。
@see 引用：这个标记将产生一个超级连接。
方法注释：
@param 变量描述：这个标记将对方法的“param”（参数）部分添加一个条目，描述方法中的参数。一个方法的所有@param标记必须放在一起。
@return 描述：这个标记将对当前方法添加“return”（返回）部分，描述返回值。
@throws 描述：这个标记将添加一个注释，用于表示这个方法有可能抛出异常。

实例：
类的注释：必须放在import语句之后，类定义之前

    /**
      *  类的描述
      *  @author wangli
      *  @Time 2017-8-13 17:09:35
      * 
      * /
      public class Test {
       ... ...
      }

构造器的注释：放在构造器的上面

    /**
      * 构造器的描述
      * @author wangli
      * @param value
      *  
      * /
      public Test(String value) {
       ... ...
      }

方法的注释：放在方法的上面

     /**
       * 方法的描述
       * @param value
       * @return 
       * @throws (方法异常使用)
       * @author wangli
       * @Time 2017-8-13 17:09:35
       *  
       * /
       public void Test(String value){
           ... ...
        }

字段/属性注释：位于字段或属性的后面，对字段进行描述

    public int id;//用户id
    public String name;//用户姓名
    public char sex;//用户姓名
    public byte age;//用户年龄
    public Date birthday;//用户生日

注释是一个说明，帮助自己更清晰程序，帮助他人更易理解代码。所以希望还没习惯写注释的朋友也开始重视注释。