当前位置: 首页 > 后端技术 > Node.js

笔记编写可读代码的艺术

时间:2023-04-03 16:06:51 Node.js

阅读原文1.代码要通俗易懂唯一标准:别人理解的最短时间2.把信息塞进名字里选择专业用语避免通用名称使用具体的名字而不是抽象名称的名称是承载更多信息的名称。名字的范围越大,名字越长越好。无用的词被丢弃。更多选择有senddeliver、dispatch、announce、distribution、routefindsearch、extract、locate、recoverstartlaunch、create、begin、openmakecreate、setup、build、generate、compose、add、new3。美学之前学设计的时候看了一本书,写了一本设计书(第3版)给大家把这本书里设计美学的原理应用到写代码的时候,道理很贴切。如果你读了这本书,你的审美能力会大大提高。对齐、重复、对比、亲密、亲密、小节顺序4.写什么样的评论?不要写一眼就能看懂的注释,类似这个地方。从名字上看懂,记录下自己的想法,加注释指出有坑的地方,要简明扼要,不要啰嗦,不要用模棱两可的代词,不要像算命先生一样说话,怎么解释是对的5.可读性控制流追求的是最少的理解时间而不是最少的代码行数,尽早返回结果,少嵌套,要尽可能扁平的理解执行过程。有些是串行执行的。有些可能随时执行,比如事件回调避免使用while,一般我们循环遍历数组,为什么不使用forEach呢?6.Splitsuper-longexpressionsSplitsuper-longexpressionsSplithugestatements尽量把逻辑包裹在函数中,不要重复自己DRY7。变量和可读性减少变量,变量越少越好减少中间结果,垂直消耗减少用于控制流程的变量并缩小变量的范围。使用变量重新定义。不要提前定义它们,否则你要随时想一想,之前定义的变量是干什么用的?8、重构抽取不相关的子问题,将各种配置变量一起抽取。它们都是配置。尽量写纯函数。创建大量通用代码。创建自己的武器库。简化界面。一次只做一件事10.少写代码最好的代码是没有代码不要费心去实现那个功能,你不会需要问题和拆分需求保持一个小的代码库删除无用的代码删除无注释11.调试尽可能打印错误,不要隐藏它们