当前位置: 首页 > news >正文

手把手教你写出令人窒息的烂代码

在 GitHub 上有一个新项目,它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。

为了保持与原 GitHub 项目一致的风格,下文没有进行转换。读者们可以以相反的角度来理解所有观点,这样就能完美避免写出垃圾代码。

项目地址:https://github.com/trekhleb/state-of-the-art-shitcode

当然,以下十九条垃圾代码书写准则并没有面面俱到,如果读者们发现有一些难以忍受的烂代码习惯,也可以发表你的看法。

???? 第一条:打字越少越好

如果我们键入的东西越少,那么就有越多的时间去思考代码逻辑等问题。如下所示,「Good」表示遵循该规则的示例,Bad 表示没遵循该规则的示例。

???? 第二条:变量/函数混合命名风格

我们需要混合命名方法与变量,这样才能体现命名的多样性。

????第三条:不要写注释

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

????第四条:使用母语写注释

如果你违反了第三条规则,那么至少写注释需要用你的母语或者其它语言。如果你的母语是英语,那么你也算违反了这条规则。既然编程语言绝大多数都是用英文,那么为什么不用其它语言注释一下?

????第五条:尽可能混合不同的格式

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

????第六条:尽可能把代码写成一行

如果一系列参数与方法都是一起实现的,那么代码也要写在一起。

????第七条:发现错误要保持静默

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

????第八条:广泛使用全局变量

使用全局变量,是面向「全球化」不可或缺的部分。

????第九条:构建备用变量

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

????第十条:Type 使用需谨慎

一般不要指定变量类型或者经常做类型检查,无类型才是最好的类型。

????第十一条:准备「Plan B」

你需要准备一些运行不到的代码(unreachable code),它们可以作为你的「Plan B」。

????第十二条:嵌套的三角法则

如果代码有一些嵌套结构,或者说缩进空行的结构,三角法则是最漂亮的。

????第十三条:混合缩进

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

????第十四条:不要锁住依赖项

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

????第十五条:长函数比短函数好

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

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

????第十六条:代码不需要做特定测试

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

????第十七条:尽量避免重复代码

按你的想法写代码,尤其是在小团队中,毕竟这是「自由」准则。

????第十八条:构建新项目不需要 README 文档

在项目前期,我们可以暂时保持这种状态。

????第十九条:保存不必要的代码

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

精彩回顾

♡ 程序员究竟能干多少年?

♡ 互联网公司各岗位真实工作内容起底

♡ 一次尴尬的采访和程序员的传奇脑洞!

♡ 天一冷,程序员都穿上格子衫

♡ 史上最真实的行业鄙视链曝光

♡ IT公司老板落水,各部门员工怎么救

♡ 宿命之战:程序员VS产品经理

♡ 作为一个前端,可以如何机智地弄坏一台电脑?

♡ 程序员跟产品经理打起来了,这是一个需求引发的血案...

♡ 后端说,你个前端不会用 headers吧,我怒了!

♡ 有个厉害的程序员女朋友是什么体验?

♡ 多年来,程序员经常加班的真相终于揭开了…

相关文章:

  • 多线程问题
  • 写 Python 到底用什么编辑器好?鹅厂程序猿吵翻了
  • 2020年2月全国程序员工资统计,平均工资13716元
  • 用户怎么使用你设计的产品,你永远想不到!
  • Git 高级用法小抄
  • 祖传代码千万别动
  • 这个IDEA插件可以帮你少写30%的代码,我是已经爱上了
  • 某IT公司的面试题,难度系数“爆表”。。。
  • 菜鸟和专业人士配对编程
  • 聊一聊Spring Boot中 RESTful接口设计规范
  • 一个故事讲完CPU的工作原理
  • Docker 入门看这一篇就够了!
  • 开发人员各种鄙视链
  • 【趣图】我和我的代码......
  • 这款网络排查工具,堪称神器!
  • (ckeditor+ckfinder用法)Jquery,js获取ckeditor值
  • 4. 路由到控制器 - Laravel从零开始教程
  • Angular 4.x 动态创建组件
  • co.js - 让异步代码同步化
  • ESLint简单操作
  • HTML-表单
  • JAVA SE 6 GC调优笔记
  • JAVA_NIO系列——Channel和Buffer详解
  • JavaScript新鲜事·第5期
  • MySQL主从复制读写分离及奇怪的问题
  • opencv python Meanshift 和 Camshift
  • PAT A1017 优先队列
  • Python代码面试必读 - Data Structures and Algorithms in Python
  • ReactNative开发常用的三方模块
  • Redis中的lru算法实现
  • Vue组件定义
  • 构建工具 - 收藏集 - 掘金
  • 机器学习学习笔记一
  • 计算机常识 - 收藏集 - 掘金
  • 少走弯路,给Java 1~5 年程序员的建议
  • 小程序开发之路(一)
  • 译自由幺半群
  • 再次简单明了总结flex布局,一看就懂...
  • 浅谈sql中的in与not in,exists与not exists的区别
  • ​决定德拉瓦州地区版图的关键历史事件
  • # C++之functional库用法整理
  • #mysql 8.0 踩坑日记
  • #Ubuntu(修改root信息)
  • #快捷键# 大学四年我常用的软件快捷键大全,教你成为电脑高手!!
  • $HTTP_POST_VARS['']和$_POST['']的区别
  • (AngularJS)Angular 控制器之间通信初探
  • (二)正点原子I.MX6ULL u-boot移植
  • (二开)Flink 修改源码拓展 SQL 语法
  • (附源码)springboot 基于HTML5的个人网页的网站设计与实现 毕业设计 031623
  • (附源码)ssm考生评分系统 毕业设计 071114
  • (论文阅读23/100)Hierarchical Convolutional Features for Visual Tracking
  • (一)eclipse Dynamic web project 工程目录以及文件路径问题
  • (原創) 如何動態建立二維陣列(多維陣列)? (.NET) (C#)
  • (转)可以带来幸福的一本书
  • (转载)虚幻引擎3--【UnrealScript教程】章节一:20.location和rotation