高质量编程
如之
这个作者很懒,什么都没留下…
展开
-
编写可读代码之一(度量问题)--读书笔记
代码编写时,我们通常要考虑架构,测试,效率等因素。在这些因素之外,代码可读性是一种很重要的原则。不管是今后代码的复用,维护,还是学习,构建可读性好的代码无疑是正确的。我们编写代码时,通常会按直觉或者灵感,也会按直白和紧凑来写。那么这些定法到底是好不好呢。有没有一个对这些写法的度量标准呢。 代码的写法应该使理解的时间最小化,这个理解不光是别人,也是几个月后的自己。自己写的代码在很长时间...原创 2018-05-25 09:50:46 · 334 阅读 · 0 评论 -
不要使用容易被误解的名字
编码过程中要主动找到误解点,多问自己几遍该名字是否会被误解成别的意思。 比如filter这个词,大家可以理解成过滤,但是就比较不清楚,过滤是剔除还是保留呢? 1、推荐使用maxg与min来包含极限 编程时,经常为用到最大值最小值宏的定义,但是很多时候从字面我们无法理解,该值是否包含在范围内。比如说我们定义购物车中可以存放在最大物品数。 #define CARD_MAX_LIMITS ...原创 2018-09-18 17:38:31 · 655 阅读 · 0 评论 -
代码要有美感
使用好的留白,对齐及顺序可以上代码更加养眼。有以下三个原则可以参考: 使用一致的布局,让读者很快就习惯这种风格。 让相似的代码看上去相似。 把相关的代码分组,形成代码块。 1、使用一致性风格 编代码过程中要做过代码风格一致,而如果是在添加或者改代码过程中,则要保持与原有风格一致。比如说代码块的风格: void func(){ int fVal = 0; } void fu...原创 2018-09-19 09:29:42 · 640 阅读 · 0 评论 -
如何写注释
写注释的关键指导原则就是尽量帮助读者了解跟作者一样多。 1、不必要的注释 如果能从代码本身看出的事实写注释。 这样注释完全多余,从代码本身就可以看出代码的意思。 也不能使用跟代码一样的意思重复注释,比如: //Find a Node with the given 'name' or return NULL Node * FindNodeInSubtree(Node* subtree...原创 2018-09-20 09:32:36 · 6024 阅读 · 0 评论