代码审查注意事项

代码审查注意事项

数据库部分：

1. 重申，数据库表字段定义禁止“可null”，如有相关需求，用空字符串或自己定义的特殊值来表达；
2. 数据库表字段加注释，注释尽量详细；
   例如：枚举式字段值要写清楚每个枚举元素值的具体含义。如：0-男，1-女，2-孩儿，3-未知；
3. 存储过程整体功能加注释，存储过程输入输出参数加注释，存储过程内语句加注释（简单语句以自身为单位注释，复杂语句以其中单个SELECT语句为单位作注释）；
   注：自定义输出标识变量的取值，所对应的实际含义一定要说清楚，如SET output = 1; # 1代表用户名不存在。
   注：写清楚作者，创建日期，修改日期，写了啥，改了啥。
4. 存储过程禁用“@”前导变量名，所有变量应该使用DECLARE方式声明（存储过程内声明的变量与形参应以语义方式加以区分）；
   例如：传入参数：para_username, 内部变量：local_username.
5. 重申数据库表命名规则，重申数据库字段命名规则，重申数据库存储过程命名规则。
6. 重申代码缩进和空格问题，重申别名命名规则。
   另参考：http://www.jianshu.com/p/7bfda5e49f0a

TypeScript部分：

1. 整体注释：

   /** 
    * @author: 作者 E-mail: 
    * @version: 版本 
    * @created: 时间
    * @remarks: 说明
    * @modified: 时间
    * @remarks: 说明
    */
   

2. 添加必要注释，删除无关注释；

3. 删除无关语句，例如多余空格、空行以及console.log()等；

4. 变量命名，遵循之前的规定；
   另参考： http://www.jianshu.com/p/8d6f877d833a

注释的作用：注释不追求长篇大论，字字注释，遵循宗旨就是能让你自己或其他人“以最快速度准确看懂你的整个逻辑流程以及局部逻辑细节”。