薄情先生|你所需要知道的代码整洁之道
程序是写给人读的 , 只是偶尔让计算机执行一下 。—— Donald Ervin Knuth
序每次 review 过往写的代码 , 总有一种不忍直视的感觉 。 想提高编码能力 , 故阅读了一些相关书籍及博文 , 并有所感悟 , 今将一些读书笔记及个人心得感悟梳理出来 。 抛转引玉 , 希望这砖能抛得起来 。
大纲
- 坏味道的代码
- 圈复杂度
- 重构
- 代码整洁之道
- 编码原则i < val; i++) {doSomething(i)}// ...}复制代码after:
function setMaxVal(val) {return val > MAX_VAL ? MAX_VAL : val}function getCircleArea(val) {for (let i = 0; i < val; i++) {doSomething(i)}}function example(val) {return getCircleArea(setMaxVal(val))}复制代码
3. 逆向条件简化条件判断某些复杂的条件判断可能逆向思考后会变的更简单 , 还能减少嵌套 。
before:
function checkAuth(user){if (user.auth) {if (user.name === 'admin') {// ...} else if (user.name === 'root') {// ...}}}复制代码
after:
。 function isYoungGirl(age, gender) {return (age < 20 while (conditioncontinue;}}复制代码
像done这样的变量 , 称为“控制流变量” 。 它们唯一的目的就是控制程序的执行 , 没有包含任何程序的数据 。 控制流变量通常可以通过更好地运用结构化编程而消除 。
如果有多个嵌套循环 , 一个简单的break不够用 , 通常解决方案包括把代码挪到一个新函数中 。
重新组织函数提炼函数当一个过长的函数或者一段需要注释才能让人理解用途的代码 , 可以将这段代码放进一个独立函数中 。
- 函数的粒度小 , 被复用的机会就很大;
- 函数的粒度小 , 覆写也会更容易些 。
将查询函数和修改函数分离【薄情先生|你所需要知道的代码整洁之道】某个函数既返回对象状态值 , 又修改对象状态 。 建立两个不同的函数 , 其中一个负责查询 , 另一个负责修改 。
以明确函数取代参数有一个函数 , 其中完全取决于参数值而采取不同行为 。 针对该参数的每一个可能值 , 建立一个独立函数 。
引入参数对象某些参数总是很自然地同时出现 , 以一个对象取代这些参数 。
从函数中提前返回可以通过马上处理“特殊情况” , 并从函数中提前返回 。
拆分巨大的语句如果有很难读的代码 , 尝试把它所做的所有任务列出来 。 其中一些任务可以很容易地变成单独的函数(或类) 。 其他的可以简单地成为一个函数中的逻辑“段落” 。
其他建议及思路减少循环内的嵌套在循环中 , 与提早返回类似的技术是continue 。 与if...return;在函数中所扮演的保护语句一样 , if...continue;语句是循环中的保护语句 。 (注意:JavaScript 中 forEach 的特殊性)
德·摩根定律对于一个布尔表达式 , 有两种等价写法:
- not (a or b or c) <=> (not a) and (not b) and (not c)
- not (a and b and c) <=> (not a) or (not b) or (not c)
// beforeif (!(file_exitstsbothshould depend on abstractions.Abstractions should not depend ondetails.Details should depend upon abstractions.
高层模块不应该依赖低层模块 , 二者都该依赖其抽象 。 抽象不应该依赖细节 , 细节应该依赖抽象 。
推荐阅读
- 张先生18823381855|转让海翼国际控股
- 先生|一停就是10年,60万豪车竟没人要?车主说:我不能动……
- 明星八卦|靳东亮相新戏发布会,阵容曝光被批不如《恋爱先生》,你怎么看
- 9月7日晚间|柏堡龙:实际控制人陈伟雄先生、陈娜娜女士解除质押共约2690万股
- 先生|60万豪车竟没人要?车主说:我不能动……,一停就是10年
- 趣头条|全新一代奔驰S级全球首发!改变不止于你所见!
- 包先生|什么包显品味还不撞包?看看这篇你就知道了!
- 疫情后的九先生轰趴馆市场前景依旧稳定
- 薄情先生|热烈祝贺首批CPAC分散控制系统产品正式交付
- 薄情先生|汉华推出氮化镓PD快充散热解决方案,全方位满足电源厂商需求