前言：
好的代码规范是一个程序员的基本修炼，好的代码注释更能体现一个程序员的思维逻辑，虽然代码是用来给机器运行的，我们只要能写出能让编译器运行的代码就行了，但是如果没有好的编码规范，到项目后期，加入开发的人员逐渐增多时，每个人的编码风格都不一样，这就会让项目维护者很难维护，所以开始就要制定一些好的规范来让大家遵守，这样才能写出可维护，健壮的项目，这就是接下来要做的事情。
————————————————
包含:单句注释、文档字段名注释、代码块注释(Block)、 类注释(Class)、构造函数注释(Constructor)、方法注释(Methods)、版权注释，然后分别为eclipse、IDEA创建注释模块等。
———————————————
一、注释规范
1、单句注释，单行注释以//开头，行末结尾；
1 User user=new User(); //实例化一个用户
2、字段名注释,文档注释以/**号开头，以*/结尾；多行注释以/*号开头，以*/结尾；
1 /**
2 * 用户名
3 */
4 public String name;
或者使用如下格式:
1 /**用户名**/
2 public String name;
3、代码块注释(Block)；
1 /**
2 * 实例化一个用户
3 * xxxxxxx
4 */
5 User user=new User();
4、类注释(Class)；
1 /**
2 * @version: V1.0
3 * @author: fendo
4 * @className: user
5 * @packageName: user
6 * @description: 这是用户类
7 * @data: 2017-07-28 12:20
8 **/
5、构造函数注释(Constructor)；
构造函数注释(Constructor)主要用来声明该类的构造函数、入参等信息；
1 /**
2 * @description: 构造函数
3 * @param: [sid, pid]
4 */
6、方法注释(Methods)；
方法注释(Methods)主要用来声明该类的作用、入参、返回值、异常等信息；
1 /**
2 * @author: fendo
3 * @methodsName: addUser
4 * @description: 添加一个用户
5 * @param: xxxx
6 * @return: String
7 * @throws:
8 */
注意：注释中的参数一定要全面，一般包含参数和返回值。
7、版权注释；
版权注释主要用来声明公司的一些基本信息等；
1 /**
2 * projectName: xxx
3 * fileName: Tk.java
4 * packageName: xxxx
5 * date: 2017年12月18日下午12:28:39
6 * copyright(c) 2017-2020 xxx公司
7 */
注意：版权一定要与 date的时间一致。
内容仅供个人学习、记录使用，侵删。