代码的坏味道

代码首先是写给人看的,只是恰巧(incidentally)能够运行。 ----Paul Graham
现在写C++服务后端,工作内容大部分是推荐系统后台开发。推荐系统算是公司技术架构中比较基础服务的模块,所以对代码质量的要求比较高。之前做游戏很多时候代码都是赶工的,也没有很好的静下来思考去重构,几天没事重构了之前的一个模块,重构后,代码可读性有了很大提升。
我们都知道要追求高质量的代码,什么是高质量的代码,这个标准就比较高了,但我们需要至少保证不写出很难维护的代码。平时每次的pr都需要被经理review,自己写代码的要求越来越高。

代码的坏味道体现在:

1.注释太多或者太少

整个代码都是很多的注释,整个屏幕没几行是代码的,想要看个整个代码还需要翻好几页,能够维护你的代码的人,能力都是和你比较接近的,别人还不是那么蠢。
每个人负责的功能还是有一点的不同,有时候的确遇到一些功能,实现起来比较曲折,如果不是自己写的别人很难理解错误,这时候需要额外注释一下,利于后来人的维护。

2.代码风格不统一

这个一般出现在新人的代码中,比如匈牙利命名和驼峰命名法交叉使用,看起来就让人厌恶,代码风格整体必须保持统一,整体看起来不那么乱。

std::vector<int64_t> gid_list;
std::vector<int>  uidList;

3.函数命名

看一段代码,首先看到的是代码的函数名,好的代码,一看函数名就知道函数的作用,烂的代码,函数名字模棱两可,让人只能去读函数的每一行代码才能读懂。

bool check(int64_t gid);       //1
bool isAvaliable(int64_t gid); //goods

对于一些检测函数,以肯定的语句更合适。

4.变量命名

初学者经常容易用t1,t2,t3等以字母加数字组合的方式来命名。变量命宁愿长点也不要太短。
比如要保存itemcf推荐的物品gid列表。

std::vector<int64_t> gids;        //1
std::vector<int64_t> itemcf_gids;  //goods

i,j,k一般仅用于for循环中的下标。推荐换为具体的下表定义单词。

5.代码一行字符太多

有的函数声明就好长的一行,要看完还得需要移动光标到最后,继续往后翻,这种看了就不想看,一般不要超过80字符,有些不可避免的过长,换行然后第二行插两个tab对齐。

6.函数体函数太长

一个函数体代表了一个模块的封装,如果函数的实现太长,有的甚至一屏幕都看不完,这时候你是不是需要考虑你的模块划分的有问题了,一般来说函数体平均不要超过50行,对于模块进行正确的划分。完全能够减少函数的行数,使得函数实现更清晰明了。

7.重复的代码

在实现功能的时候,完全只考虑怎么实现逻辑,完全没去想结构的调整,重复的逻辑出现了好几次,代码块看起来臃肿不堪,需要很大力气才能读懂。
面向对象的继承,多态,封装这些的出现都是为了解决代码复用的问题,对于重复的逻辑完全可以将重复的功能提炼出来,封装成一个函数,再去调用。

8.错误的设计

本来可以有的更简洁的实现,被实现的过于繁琐,让人看起来啰里啰嗦,打个简单的比方,需要保存一个列表,列表里每个元素只能唯一,如果被设计用vector去实现,还需要自己每次push_back时还需要手动去查找,如果一开始用set来存储,代码就会简洁很多。(这个例子貌似不大合适)

9.缺乏一定的抽象能力

主要体现在一个最初的一个简单需求,后来提了更多的需求,到最后一个功能有了好多的变种实现,功能代码很难复用,比如对于一个初期的推荐,最开始需要保存的数据只是物品信息表以及一些操作一个类ReposManger就够了,后期可能需要用户的浏览记录,心愿单,用户画像等,该类操作越来越多,需要管理的数据越来越庞大,架构都不敢随便动。这个主要体现在项目组里开发效率比较高的人,大量的业务开发工作导致没做过多的思考,要体会到这个坏味道需要一定的经验。

要消除这些代码的坏味道,只有通过多写,多思考,多看好的代码!

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

推荐阅读更多精彩内容