怎样写一手烂代码

写代码其实就像写文章一样,不仅需要有一个主旨,告诉别人代码的作用是什么,还要在精炼与易读之间做权衡,代码过于精炼,整体逻辑难以跟随,代码过于易读,整体就显得比较臃肿。

如果问你什么是好代码,相信你能说出一堆规则,比如使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过度精简代码等等。那么,对于什么是烂代码,你是否有个比较清晰的认知呢?

日前,公众号“机器之心”编译了 GitHub 上的一个项目,该项目介绍了“最佳垃圾代码”的 19 条关键准则。本文从中精选出 10 条准则分享给你,你可以从相反的角度来理解这些观点,避免写出垃圾代码。

1. 打字越少越好

输入的东西越少,那么就有越多的时间去思考代码逻辑等问题。

2. 不要写注释

反正代码都看得懂,为什么要写注释?或者说,反正没人看我的代码,为什么要写注释?

3. 尽可能混合不同的格式

为了代码的多样性,你尽可能混合不同的格式,例如单引号或双引号。如果它们的语义相同,那就应该混用。

4. 发现错误保持静默

当你发现某些错误时,其他人不需要了解它,因此你不必打印出日志。

5. 构建备用变量

以防万一,你需要创建一些备用变量,在需要时随时调用它们。

6. 锁住依赖项

每一次要安装新库时,更新已有的依赖项。为什么要维持之前的版本呢,你需要时刻保持最新的第三方代码库。

7. 混合缩进

你要避免采用缩进,因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进的话,可以使用混合缩进策略。当然,这种策略在 Python 中是行不通的,因为它靠缩进来确定代码结构。

8. 长函数比短函数好

不要将程序整体逻辑分割为一些代码块,要是 IDE 突然不行了,它找不到必要的文件或函数该怎么办?因此,你需要把代码写在一个主体函数中,并且不再维护额外的函数导入或代码文件,这样的方法才是最稳定的。

单个文件一万行代码是没问题的,单个函数一千行代码也是没问题的。

9. 代码不需要做特定测试

这些测试通常是重复且无意义的工作。

10. 保存不必要的代码

在写代码的过程中,经常会产生很多测试代码。这些代码也是非常重要的资料,因此不能删除掉,最多只能注释掉。

以上就是写出烂代码的 10 条准则,如果你想写出好代码的话,就要从相反的角度进行理解。在你看来,还有哪些烂代码准则呢?欢迎在留言区补充。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,847评论 0 1
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,505评论 3 3
  • 更新时间:2016/5/13 介绍 本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Pytho...
    超net阅读 5,925评论 0 15
  • Python的初学者,开发者都应该知道的代码可读性提高技巧,本篇主要介绍了如下内容: PEP 8是什么以及它存在的...
    妄心xyx阅读 1,860评论 0 16
  • 红情之.三 看来年味浓, 高挂几灯笼。 温暖心中景, 吉祥好运逢。
    明月清泉_e47b阅读 264评论 2 8