代码审查注意事项

代码审查注意事项

数据库部分:

  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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352

推荐阅读更多精彩内容