写代码其实就像写文章一样,不仅需要有一个宗旨,告诉别人代码的作用是什么,还要在精炼与易读之间做权衡,代码过于精炼,整体逻辑难以跟随,代码过于易读,整体就显得比较臃肿。
假如问你什么是好代码,相信你能说出一堆规则,比方使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过度精简代码等等。那么,对于什么是烂代码,你能否有个比较清晰的认知呢?
日前,公众号“机器之心”编译了 GitHub 上的一个项目,该项目详情了“最佳垃圾代码”的 19 条关键原则。本文从中精选出 10 条原则分享给你,你可以从相反的角度来了解这些观点,避免写出垃圾代码。
1. 打字越少越好
输入的东西越少,那么就有越多的时间去思考代码逻辑等问题。
2. 不要写注释
反正代码都看得懂,为什么要写注释?或者者说,反正没人看我的代码,为什么要写注释?
3. 尽可能混合不同的格式
为了代码的多样性,你尽可能混合不同的格式,例如单引号或者双引号。假如它们的语义相同,那就应该混用。
4. 发现错误保持静默
当你发现某些错误时,其余人不需要理解它,因而你不必打印出日志。
5. 构建备用变量
以防万一,你需要创立少量备用变量,在需要时随时调用它们。
6. 锁住依赖项
每一次要安装新库时,升级已有的依赖项。为什么要维持之前的版本呢,你需要时刻保持最新的第三方代码库。
7. 混合缩进
你要避免采用缩进,由于缩进会使复杂代码在编辑器中占用更多的空间。假如肯定要采用缩进的话,可以使用混合缩进策略。当然,这种策略在 Python 中是行不通的,由于它靠缩进来确定代码结构。
8. 长函数比短函数好
不要将程序整体逻辑分割为少量代码块,要是 IDE 忽然不行了,它找不到必要的文件或者函数该怎样办?因而,你需要把代码写在一个主体函数中,并且不再维护额外的函数导入或者代码文件,这样的方法才是最稳固的。
单个文件一万行代码是没问题的,单个函数一千行代码也是没问题的。
9. 代码不需要做特定测试
这些测试通常是重复且无意义的工作。
10. 保存不必要的代码
在写代码的过程中,经常会产生很多测试代码。这些代码也是非常重要的资料,因而不能删除掉,最多只能注释掉。
以上就是写出烂代码的 10 条原则,假如你想写出好代码的话,就要从相反的角度进行了解。在你看来,还有哪些烂代码原则呢?欢迎在留言区补充。