垃圾代码还能出圈?手把手教你写垃圾代码,从入门到精通!
全世界只有3.14 % 的人关注了
爆炸吧知识
转自:机器之心
参与:思
如果说到什么是好代码,我们肯定都能说出一堆规则,例如使用一致的格式和缩进、使用清晰的变量名和方法名、在必要时提供文档与注释、不要过度精简代码等等。
但是对于什么是烂代码,你有比较清晰的认识吗?
在 GitHub 上有一个新项目,它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。
为了保持与原 GitHub 项目一致的风格,下文没有进行转换。读者们可以以相反的角度来理解所有观点,这样就能完美避免写出垃圾代码。
repo 地址:
https://github.com/trekhleb/state-of-the-art-shitcode
当然,以下十九条垃圾代码书写准则并没有面面俱到,如果读者们发现有一些难以忍受的烂代码习惯,也可以留言发表你的看法。
第一条:打字越少越好
如果我们键入的东西越少,那么就有越多的时间去思考代码逻辑等问题。如下所示,「Good」表示遵循该规则的示例,Bad 表示没遵循该规则的示例。
第二条:变量/函数混合命名风格
我们需要混合命名方法与变量,这样才能体现命名的多样性。
第三条:不要写注释
反正代码都看得懂,为什么要写注释?或者说,反正没人看我的代码,为什么要写注释?
第四条:使用母语写注释
如果你违反了第三条规则,那么至少写注释需要用你的母语或者其它语言。如果你的母语是英语,那么你也算违反了这条规则。既然编程语言绝大多数都是用英文,那么为什么不用其它语言注释一下?
第五条:尽可能混合不同的格式
同样,为了代码的多样性,我们需要尽可能混合不同的格式,例如单引号或双引号。如果它们的语义相同,那就应该混用。
第六条:尽可能把代码写成一行
如果一系列参数与方法都是一起实现的,那么代码也要写在一起。
第七条:发现错误要保持静默
当你发现某些错误时,其他人不需要了解它,因此不需要打印出日志或 Traceback。
第八条:广泛使用全局变量
使用全局变量,是面向「全球化」不可或缺的部分。
第九条:构建备用变量
以防万一,我们需要创建一些备用变量,在需要时随时调用它们。
第十条:Type 使用需谨慎
一般不要指定变量类型或者经常做类型检查,无类型才是最好的类型。
第十一条:准备「Plan B」
你需要准备一些运行不到的代码(unreachable code),它们可以作为你的「Plan B」。
第十二条:嵌套的三角法则
如果代码有一些嵌套结构,或者说缩进空行的结构,三角法则是最漂亮的。
第十三条:混合缩进
我们需要避免采用缩进,因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进,那么就使用混合缩进策略。当然,这种策略在 Python 中是行不通的,因为它靠缩进来确定代码结构。
第十四条:不要锁住依赖项
每一次要安装新库时,更新已有的依赖项。为什么要维持之前的版本呢,我们需要时刻保持最新的第三方代码库。
第十五条:长函数比短函数好
不要将程序整体逻辑分割为一些代码块,要是 IDE 突然不行了,它找不到必要的文件或函数怎么办。因此把代码写在一个主体函数中,并且不再维护额外的函数导入或代码文件,那么这样的方法是最稳定的。
单个文件一万行代码是没问题的,单个函数一千行代码也是没问题的。
第十六条:代码不需要做特定测试
这些测试通常是重复且无意义的工作。
第十七条:尽量避免重复代码
按你的想法写代码,尤其是在小团队中,毕竟这是「自由」准则。
第十八条:构建新项目不需要 README 文档
在项目前期,我们可以暂时保持这种状态。
第十九条:保存不必要的代码
在写代码的过程中,经常会产生很多测试代码。这些代码也是非常重要的资料,因此不能删除掉,最多只能注释掉。
转自:机器之心,转载仅供学习交流,如有侵权请联系删除。
????????????
超超超级宠粉福利
锦鲤好运书单,100本免费送!
百本好书,六大类目,总有一本适合你
后台回复“领书”查看书单,立即自选领书
万水千山总是情,点个 “在看” 行不行
垃圾代码还能出圈?手把手教你写垃圾代码,从入门到精通!相关推荐
- 手把手教你写web全栈入门项目—React+Koa+MongoDB(3w字教程,真的很详细,有代码)
手把手教你写web全栈入门项目-React+Koa+MongoDB
- 大厂秘籍:谷歌代码规范开放下载,手把手教你写出好代码
这两天和一位大厂的朋友聊天,说起他们今年技术岗晋级答辩要增加代码走读环节,那该如何写出好看又好用的代码? 代码是程序员改变世界的工具,每个程序员都会写代码,但不一定能写出好代码. 如今的大型商业软件系 ...
- python跑得慢_代码跑得慢甩锅Python?手把手教你如何给代码提速30%
原标题:代码跑得慢甩锅Python?手把手教你如何给代码提速30% 来源丨Medium 编译丨王转转 大数据文摘出品 https://mp.weixin.qq.com/s/bY3REj6qVw0M1N ...
- 手把手教你写需求之代码实现pdf转jpg
前言 初入公司,很多朋友如果碰到一些莫名其妙的需求,没有做过就会很慌张.不要慌张,本文通过一个小案例手把手教你写需求. 场景 一个阳光明媚的下午,需求小姐姐向你款款走来,娇滴滴的寻求你帮忙,她需要你把 ...
- C# 用真实需求,手把手教你写面向对象的代码
好久没写过文章了,这里工作很忙. 今天继续给大家讲解下,怎么写面向对象的代码.之前也写过类似的文章,但那都是随便举的例子,不是活生生的现实案例. 今天使用我刚写的项目来举例子,它是真实存在的需求案例, ...
- 手把手教你用Pytorch代码实现Transformer模型(超详细的代码解读)
手把手教你用Pytorch代码实现Transformer模型(超详细代码解读)
- 手把手教你写电商爬虫-第二课 实战尚妆网分页商品采集爬虫
系列教程 手把手教你写电商爬虫-第一课 找个软柿子捏捏 如果没有看过第一课的朋友,请先移步第一课,第一课讲了一些基础性的东西,通过软柿子"切糕王子"这个电商网站好好的练了一次手,相 ...
- 手把手教你写网站:Python WEB开发技术实战
摘要:本文详细介绍了Python WEB开发的基础入门.以一个博客站点的开发为例讲解了基于Django框架开发WEB站点的全过程.通过本文的学习可以快速掌握基于Django的Python WEB的开发 ...
- hecto - 手把手教你写个 文本编辑器
https://www.philippflenker.com/hecto/ 的阅读笔记. 我是学完[[Rust权威指南]] 之后才看的这个. 手把手教你写个 文本编辑器(1300+行代码). 作者是真 ...
最新文章
- tilemap 导入unity_教程|Unity中使用Tilemap快速创建2D游戏世界
- 中国产业园区发展动态及前景趋势规划建议报告2022-2028年版
- 全志 添加外挂RTC Hym8563
- 01.MyBatis入门
- C++学习之路 | PTA(天梯赛)—— L2-007 家庭房产 (25分)(带注释)(并查集)(精简)
- MySQL运算符ppt_mysql运算符
- BM求线性递推模板(杜教版)
- LMS激光传感器的TCP/IP协议问题
- 基于555定时器的呼吸灯电路
- html中设置字体字号,html中设置字体大小的方法
- 中望CAD2019注册机|中望CAD2019注册破解补丁 下载
- 替换修改windows xp字体,为windows 7微软雅黑
- JAVA学习笔记_小写数字转换成大写且带单位_金额小写转大写
- PIAO网址PIAO
- 机器学习算法之聚类算法拓展:K-Means和Mini Batch K-Means算法效果评估
- 跨境电商如何找代运营公司?星之河
- PYTHON将成绩从百分制变换到等级制
- windows命令大全_建议收藏!这是最全的Windows快捷键使用指南
- 2014 年终总结:即使艰难,也要始终怀揣梦想
- 函数可导但是导函数不连续的例子
热门文章
- .Net之微信小程序获取用户UnionID
- 解读 Microsoft.NET.Sdk 的源码,你能定制各种奇怪而富有创意的编译过程
- 从零开始实现ASP.NET Core MVC的插件式开发(二) - 如何创建项目模板
- ASP.NET Core 3.0 自动挡换手动挡:在 Middleware 中执行 Controller Action
- MongoDB发布4.0版本,支持ACID事务
- 基于阿里云 DNS API 实现的 DDNS 工具
- Build 2018大会:.NET概述和路线图
- 跨平台应用集成(在ASP.NET Core MVC 应用程序中集成 Microsoft Graph)
- Visual Studio 2015和2017里面应该创建哪种 Class Library
- 基于ZKWeb + Angular 4.0的开源管理后台Demo