这个教人写出烂代码的项目在 GitHub 上火了...
转自机器之心
如果说到什么是好代码,我们肯定都能说出一堆规则,例如使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过度精简代码等等。
但是对于什么是烂代码,你有比较清晰的认识吗?
在 GitHub 上有一个新项目,它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。
为了保持与原 GitHub 项目一致的风格,下文没有进行转换。读者们可以以相反的角度来理解所有观点,这样就能完美避免写出垃圾代码。
项目地址:https://github.com/trekhleb/state-of-the-art-shitcode
当然,以下十九条垃圾代码书写准则并没有面面俱到,如果读者们发现有一些难以忍受的烂代码习惯,也可以留言发表你的看法。
第一条:打字越少越好
如果我们键入的东西越少,那么就有越多的时间去思考代码逻辑等问题。如下所示,「Good」表示遵循该规则的示例,Bad 表示没遵循该规则的示例。
第二条:变量/函数混合命名风格
我们需要混合命名方法与变量,这样才能体现命名的多样性。
第三条:不要写注释
反正代码都看得懂,为什么要写注释?或者说,反正没人看我的代码,为什么要写注释?
第四条:使用母语写注释
如果你违反了第三条规则,那么至少写注释需要用你的母语或者其它语言。如果你的母语是英语,那么你也算违反了这条规则。既然编程语言绝大多数都是用英文,那么为什么不用其它语言注释一下?
第五条:尽可能混合不同的格式
同样,为了代码的多样性,我们需要尽可能混合不同的格式,例如单引号或双引号。如果它们的语义相同,那就应该混用。
第六条:尽可能把代码写成一行
如果一系列参数与方法都是一起实现的,那么代码也要写在一起。
第七条:发现错误要保持静默
当你发现某些错误时,其他人不需要了解它,因此不需要打印出日志或 Traceback。
第八条:广泛使用全局变量
使用全局变量,是面向「全球化」不可或缺的部分。
第九条:构建备用变量
以防万一,我们需要创建一些备用变量,在需要时随时调用它们。
第十条:Type 使用需谨慎
一般不要指定变量类型或者经常做类型检查,无类型才是最好的类型。
第十一条:准备「Plan B」
你需要准备一些运行不到的代码(unreachable code),它们可以作为你的「Plan B」。
第十二条:嵌套的三角法则
如果代码有一些嵌套结构,或者说缩进空行的结构,三角法则是最漂亮的。
第十三条:混合缩进
我们需要避免采用缩进,因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进,那么就使用混合缩进策略。当然,这种策略在 Python 中是行不通的,因为它靠缩进来确定代码结构。
第十四条:不要锁住依赖项
每一次要安装新库时,更新已有的依赖项。为什么要维持之前的版本呢,我们需要时刻保持最新的第三方代码库。
第十五条:长函数比短函数好
不要将程序整体逻辑分割为一些代码块,要是 IDE 突然不行了,它找不到必要的文件或函数怎么办。因此把代码写在一个主体函数中,并且不再维护额外的函数导入或代码文件,那么这样的方法是最稳定的。
单个文件一万行代码是没问题的,单个函数一千行代码也是没问题的。
第十六条:代码不需要做特定测试
这些测试通常是重复且无意义的工作。
第十七条:尽量避免重复代码
按你的想法写代码,尤其是在小团队中,毕竟这是「自由」准则。
第十八条:构建新项目不需要 README 文档
在项目前期,我们可以暂时保持这种状态。
第十九条:保存不必要的代码
在写代码的过程中,经常会产生很多测试代码。这些代码也是非常重要的资料,因此不能删除掉,最多只能注释掉。
这个教人写出烂代码的项目在 GitHub 上火了...相关推荐
- 哈哈哈,这个教人写出烂代码的项目在 GitHub 上火了...
如果说到什么是好代码,我们肯定都能说出一堆规则,例如使用一致的格式和缩进.使用清晰的变量名和方法名.在必要时提供文档与注释.不要过度精简代码等等. 但是对于什么是烂代码,你有比较清晰的认识吗? 在 G ...
- 哈哈哈,这个教人写烂代码的项目在 GitHub 上火了...
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 如果说到什么是好代码,我们肯定都能说出一堆规则,例如使用一致的格式 ...
- java 拼 变量名_你还用拼音为变量命名?新人OIer别傻了,教你写出优质代码
本篇文章适用语言:python,c++,Java.(其实我就是随便bb) 我们在编辑代码的时候,不免拿其他人的代码进行学习,或者将自己的代码拿给别人修改.这个时候,如何让别人快速读懂你的代码,是提升效 ...
- 大厂秘籍:谷歌代码规范开放下载,手把手教你写出好代码
这两天和一位大厂的朋友聊天,说起他们今年技术岗晋级答辩要增加代码走读环节,那该如何写出好看又好用的代码? 代码是程序员改变世界的工具,每个程序员都会写代码,但不一定能写出好代码. 如今的大型商业软件系 ...
- Java编程高手教你写出完美代码
点关注,不迷路:持续更新Java架构相关技术及资讯热文!!! 近期小编在学员中,发现很多人不喜欢写代码.记住基础代码.在一周前写过的Java代码,一周后还能记住多少?那么Java程序员如何做到爱上代码 ...
- 反其道而行:教人写烂代码的开源项目
点击上方蓝色"程序猿DD",选择"设为星标" 回复"资源"获取独家整理的学习资料! 如果说到什么是好代码,我们肯定都能说出一堆规则,例如使用 ...
- 19 条法则,教你写出火爆 GitHub 的烂代码!
古人云:好代码万里挑一,烂代码千篇一律. 作为一名开发者,除了我自己写的,别人的代码在我眼里大部分都是「烂代码」.但苦于资历尚欠,所以烂代码见得并不是很多,也没总结出来什么规律.但 GitHub 上的 ...
- 手把手教你写出几十种让同事无法维护的代码!
对,你没看错 本文就是教你怎么写出让同事无法维护的代码! 01 程序命名 容易输入的变量名.比如:Fred,asdf 单字母的变量名.比如:a,b,c, x,y,z(如果不够用,可以考虑a1,a2,a ...
- 从教女友写代码中学到的,教人写代码在一定程度上是硬件问题
从今年四月一直到七月,我在教我女友写代码.我最大的收获是认识到了教人写代码在一定程度上是个硬件问题.虽然 codecademy.可 汗学 院.Scratch 和其他机构为了教学优化了代码编辑器,但代码 ...
- idea代码提示插件_IDEA 插件推荐 —— 让你写出好代码的神器!
概述 今天介绍的插件主要是围绕编码规范的.有追求的程序员,往往都有代码洁癖,要尽量减少代码的「坏味道」. 代码静态检查是有很多种类,例如圈复杂度.重复率等.业界提供了很多静态检查的插件来识别这些不合规 ...
最新文章
- 火遍全国的网络热梗“yyds”,创造者被判刑3年
- h5 调起相机_Html5在手机端调用相机的方法实现
- 让你的AI绿起来,艾伦研究所提出深度学习效率评估标准Green AI
- python零基础怎么学-零基础如何入门Python
- “现金贷”产品的获客之道,这一篇就够了!
- python 入门学习篇(一),呵呵呵
- 3_python基础—运算符 2
- Dynamic Programming之Longest Increasing Subsequence (LIS)问题
- matlab钢材切割,一种基于MATLAB的钢材裂纹扩展速率试验数据处理方法
- ubuntu16.04下运行海康威视网络摄像头sdk(qtdemo)
- 冬瓜哥祝大家新年快乐!
- 随想·手中没有红玫瑰
- 易宝典——玩转O365中的EXO服务 之四十九 如何知道管理员进行了哪些操作
- AppScan渗透测试
- 小灰,你出书花了多少钱?
- 简单说 用CSS做一个魔方旋转的效果
- 第一章:ORM框架发展历程和MyBatis的核心应用
- SQL Server数据库表的基本操作(批量插入、删除、查询数据,删除表中重复数据方法)
- Freeswitch 安装
- 验证码识别之w3cschool字符图片验证码(easy级别)
热门文章
- web.config中的ExtensionlessUrlHandler-Integrated-4.0
- Objective-C学习笔记(十八)——对象方法和类方法的声明,定义及调用
- 【开发工具IDE】eclipse的web项目的tomcat安装部署问题
- 通过javascritp对表格进行列拖动排序
- PKU 1087 A Plug for UNIX
- 如何在应用程序中隐藏2021款MacBook刘海?
- 苹果mac科学计算器:PCalc
- 好用的markdown编辑工具Ulysses 25 for Mac
- 如何在M1的Mac上检查App是原生执行,还是Rosetta转译后执行?
- 为Mac任意命令设置快捷键