常说的代码整洁到底是什么

整洁代码

  1. 为什么要写草稿的代码?
    每个人都有自己的原因,相信很多人都会想着等有时间的话再进行代码优化,但是要记住一句话:稍后等于永不

  2. 混乱代码的代价
    后续难以维护和修改,生产力和时间呈现负相关。

  3. 什么是整洁的代码?
    整洁的代码只做好一件事:每个类、每个函数、每个模块都专注于一事,完全不受四周细节的干扰和污染。

更全面的概括是:减少重复代码、提高表达力、提早构建简单抽象。

更好的变量命名

  1. 见名知意

  2. 抽象工厂:接口不要命名为IShapeFactory,前导字母对于用户来说其实是干扰,用户只需要知道那是个抽象工厂,建议使用CShapeFactory或许体验更好

  3. 类名要用名词,方法要用动词,词性相近的get、fetch这种词不应出现在一起,可以添加后缀getNumber、fetchData实现相同的效果

  4. 别害怕长名字:使用描述性的名称,哪怕比较长也比短而令人费解的名称好

更好的函数

  1. 函数的结构本质上要短小、再短小,以不容纳if/else if/else嵌套结构为目标

  2. 只做一件事:正如前面所说,函数只做好一件事就足够了,标志就是“看是否还能拆出一个函数,该函数不仅只是单纯地重新诠释其实现”

  3. 每个函数一个抽象层级:代码一般是“自顶向下”的阅读顺序,每个函数后面跟着的应该是下一抽象层级的函数

    [抽象层级:getHtml函数位于较高抽象层,pagePathName = pathParser.render(pagePath)位于中间抽象层,.append("\n")则位于较低抽象层]
    
  4. switch语句:天生就需要做N件事,但是可以将其放置在较低抽象层级,但是当出现新的类型时会违反“单一权责原则、开放闭合原则”,此时最好创建多态对象

//原文中:对于每个case分支进行单独处理,添加新类型不必修改原来的代码增加新的处理类即可
function getName(name){
    switch(name){
        case 'ming':
            return new ClassMing(name);
        case 'hu':
            return new ClassHu(name);
        case 'uzi':
            return new ClassUzi(name);
        default:
            throw new ClassCommon(name);
    }
}

//我更喜欢用另一种方法:修改只需要在对象里修改即可,且提高了函数的简洁性
const nameCollectionUtils = {
    ming:new ClassMing('ming');
    hu: new ClassHu('hu');
    uzi: new ClassUzi('uzi');
}
function getName(name){
    return nameCollectionUtils.hasOwn(name) ? nameCollectionUtils[name] : new ClassCommon(name)
}
  1. 函数参数最多不多于两个:包括输入参数和输出参数

  2. 无副作用:函数内部不要做出未能预期的改动,不要对外部产生影响

  3. 使用异常替代返回错误码:使用try...catch替代多层级的if嵌套,永远走在主路上,不要过多考虑边界,这样可以让你一直保持思维连贯

  4. 错误处理单独抽出:这一条我认为可以视情况而定,毕竟抽出仅仅是为了美观

  5. 别重复:多个函数使用的相同逻辑的代码一定要抽出,可以参考面向对象的基类,前端开发中的面向组件编程、面向模块编程也是这种思想

系统

  1. 构造和使用分开:构造的细节应隔离与应用程序代码之外,使用者只能获取构造者想让使用者获得的东西

  2. 设计时要能满足从简单到复杂的更新迭代

重构

这个模块我认为是最重要的模块,甚至比怎么去编写新的程序更重要,因为一个公司的沉积项目的数据是巨大的,很可能会对其中几个甚至更多进行重构(还是因为之前代码写的太烂无法维护),所以重构中需要注意的点也要有一个清晰的认知。

只需要遵守一条原则:签入的代码比签出的更整洁。

添加新评论

icon_mrgreen.gificon_neutral.gificon_twisted.gificon_arrow.gificon_eek.gificon_smile.gificon_confused.gificon_cool.gificon_evil.gificon_biggrin.gificon_idea.gificon_redface.gificon_razz.gificon_rolleyes.gificon_wink.gificon_cry.gificon_surprised.gificon_lol.gificon_mad.gificon_sad.gificon_exclaim.gificon_question.gif