java学习笔记之注释使用模板（个人版）

                                  java学习笔记之注释使用模板（个人版）

代码也写了一年半了，经验涨了不少但是对代码的敬畏之心却越来越少了。直到前两天突然发现自己竟然变成了之前最讨厌的人——代码中不写注释的人。深恶痛绝，想想之前为了了解业务在学习代码的时候不断补充注释，自己刚开始接手开发任务的时候也是注释量快赶上代码了。现在想想真是坑爹呀，所以写一个笔记给自己一个警示。并且将工作以来所有自己写的重新补充注释，而且正在逐步将负责的模块代码补充注释。

Java注释分为三种，分别是单行注释(//xxxxx) 、多行注释(/*... 注释内容....*/)、文档注释(/**.. 注释内容....*/)。其中单行注释和多行注释是在方法内部使用的。文档注释包含版权注释、类注释、构造函数注释、属性注释、方法注释等，自己感觉除了方法内部其他地方的注释都用文档注释就好了，并且可以通过javadoc的工具可以自动生成一个HTML文档。

使用Eclipse编辑器在Windows → preferences → Java → Code Style → Code Templates → Comments下定义自己的注释，Files是版本的注释，Types是类的注释，Fields是属性的注释,Constructors是构造函数的注释，Methods是方法的注释，其他我基本没用过，也没仔细研究过。下面我就写几个我常用的注释，有些用的其实并不对，但是我也没找到标准的，所以就先用着这样的了。

   1、版权的注释（Files）：用来记录一些公司的基本信息和版权所有等，放在java文件的最上边。

• 定义的模板：

        /** 
        * <p>Title: ${file_name}</p>  
        * <p>Description: </p>  
        * <p>Company: xxxx股份有限公司</p>  
        * @author 疯狂的果丹皮
        * @date ${date} ${time}  
        * @version 1.0  
        */ 

• 实际效果：

        /**  
        * <p>Title: TestJavaDoc.java</p>  
        * <p>Description: </p>  
        * <p>Company: xxxx股份有限公司</p>  
        * @author 疯狂的果丹皮  
        * @date 2018年12月17日 下午4:49:06  
        * @version 1.0  
        */ 
        package com.cn.springboottest.test;

    2、类的注释(Types)：主要用来声明该类用来做什么，以及创建者、创建日期版本、包名等一些信息。

• 定义的模板：

      /**  
       * <p>Description: </p>  
       * @author 疯狂的果丹皮 
       * @since ${date} ${time}
       * @lastUpdate ${date} ${time} 
       * @lastUpdateBy 疯狂的果丹皮
       * @updateDescription  
       * @version 1.0  
       */

• 实际效果：

       /**
        * <p>Description: </p>  
        * @author 疯狂的果丹皮   
        * @since 2018年12月29日 下午11:32:35
        * @lastUpdate 2018年12月29日 下午11:32:35 
        * @lastUpdateBy 疯狂的果丹皮  
        * @updateDescription  
        * @version 1.0
        */
        public class TestJavaDoc {}

    3、方法的注释(Methods)：主要用来声明该类的作用、入参、返回值、异常等信息。

• 定义的模板：

       /**
        * Description:
        * @lastUpdate ${date} ${time}
        * ${tags} ${return_type}
        */

• 实际效果：

       /**
        * Description:
        * @lastUpdate 2018年12月29日 下午11:38:29
        * @param name
        * @param age
        * @return String
        */