vlambda博客
学习文章列表

拿这些代码规范去怼开发吧(一)

点击
“搜狗测试”
可关注我们!
     


引言

据说CodeReview时,每分钟的WTF可以用来衡量代码的质量好坏。

拿这些代码规范去怼开发吧(一)

小编今天就和大家一起聊聊代码规范和代码Review发现的那些"坑"。


变量命名规范

  • 命名要名副其实


示例:定义一个消逝的时间,以日计

// BadCase:int d;    

// GoodCase:int elapsedTimeInDays;

一个实例:扫雷游戏返回所有标记的格子

拿这些代码规范去怼开发吧(一)

  • 避免变量具有误导性


List一词对程序员有特殊意义,如果变量确实是List类型,否则别用accountList来描述一组账号。

accountList & accountGroup/accounts
  • 不要使用I、O、0、1作为变量名


    拿这些代码规范去怼开发吧(一)

    WTF,11和12怎么比大小!


    拿这些代码规范去怼开发吧(一)


  • 避免以数字系列命名

这是一个拷贝字符串的函数

拿这些代码规范去怼开发吧(一)

  • 使用能够读得出来的名称

拿这些代码规范去怼开发吧(一)

  • 用宏定义替代魔数的使用(全称魔鬼数字)

拿这些代码规范去怼开发吧(一)


  • 避免单字母循环计数器的陷阱

这是一个五笔查询的四层循环

// Badcase:如下图

左侧循环i写错了,右侧修改代码后内层循环j又写错了,也是醉了~~~

// GoodCase:是以level1、level2的方式命名