0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

十九条垃圾代码书写准则

Q4MP_gh_c472c21 来源:机器之心 作者:Jack-Cui 2022-05-18 14:59 次阅读

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

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

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

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

第一条:打字越少越好

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

b3c40a8e-d661-11ec-bce3-dac502259ad0.png

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

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

b3df8ea8-d661-11ec-bce3-dac502259ad0.png

第三条:不要写注释

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

b3f6656a-d661-11ec-bce3-dac502259ad0.png

第四条:使用母语写注释

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

b41e0d7c-d661-11ec-bce3-dac502259ad0.png

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

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

b4339a66-d661-11ec-bce3-dac502259ad0.png

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

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

b4508f90-d661-11ec-bce3-dac502259ad0.png

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

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

b46f2f40-d661-11ec-bce3-dac502259ad0.png

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

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

b47ff154-d661-11ec-bce3-dac502259ad0.png

第九条:构建备用变量

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

b48ec166-d661-11ec-bce3-dac502259ad0.png

第十条:Type 使用需谨慎

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

b4a8045a-d661-11ec-bce3-dac502259ad0.png

第十一条:准备「Plan B」

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

b4cd01b0-d661-11ec-bce3-dac502259ad0.png

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

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

b4f73ade-d661-11ec-bce3-dac502259ad0.png

第十三条:混合缩进

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

b51160ee-d661-11ec-bce3-dac502259ad0.png

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

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

b52fe67c-d661-11ec-bce3-dac502259ad0.png

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

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

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

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

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

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

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

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

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

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

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

END 审核编辑 :李倩

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 代码
    +关注

    关注

    30

    文章

    4758

    浏览量

    68374
  • GitHub
    +关注

    关注

    3

    文章

    467

    浏览量

    16389

原文标题:手把手教你写出令人窒息的烂代码

文章出处:【微信号:gh_c472c2199c88,微信公众号:嵌入式微处理器】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    评论

    相关推荐

    发射中心又见大红屏 神十九发射任务圆满成功

    发射中心又见大红屏!据央视新闻报道,在2024年10月30日,神舟十九号载人飞船与火箭成功分离,进入预定轨道,航天员乘组状态良好,神十九发射任务圆满成功!神舟十九号航天员乘组顺利入驻“天宫”;发射
    的头像 发表于 10-30 11:09 435次阅读

    FlexLua低代码零基础开发智能垃圾桶产品原型(接入机智云)

    目标功能介绍基于功能强大的ShineBlink低代码物联网核心模组和灵活轻巧的Lua脚本编程语言实现如下功能。1、监测和报警监测圾桶内的烟雾并声光报警监测圾桶内的酒精等有害气体并声光报警监测垃圾桶内
    的头像 发表于 07-11 08:11 1369次阅读
    FlexLua低<b class='flag-5'>代码</b>零基础开发智能<b class='flag-5'>垃圾</b>桶产品原型(接入机智云)

    基于PYNQ的智能垃圾分类系统

    第一部分 设计概述 /Design Introduction 1.1 设计目的 随着现代社会的高速发展,其带来的环境压力也越来越大,对于日益剧增的垃圾产量已经成为世界关注的焦点。垃圾分类成为
    发表于 07-09 18:44

    UART传输在控制台中显示垃圾值是哪里的问题?

    的控制台窗口上显示的不是"Hello World" ,而是垃圾字符。 我检查了流程,发现与示例代码相似,如波特率设置正确,缓冲区流程也正确。 错误还可能出现在哪里?
    发表于 07-02 08:24

    浅谈EMC设计准则

    在日益数字化的时代,电子设备的设计已成为现代生活中不可或缺的一部分。但随之而来的是电磁兼容性(EMC)问题的日益凸显。EMC设计准则的制定和遵循对于确保设备在各种环境中稳定运行并且不会干扰其他设备
    的头像 发表于 06-18 14:59 2467次阅读
    浅谈EMC设计<b class='flag-5'>准则</b>

    基于Vision Board上的openMV垃圾分类

    通过在Vision Board部署openMV实现垃圾分类。
    的头像 发表于 06-17 10:49 594次阅读
    基于Vision Board上的openMV<b class='flag-5'>垃圾</b>分类

    智能垃圾回收箱功能实验

    需要系统地介绍智能垃圾回收箱软件硬件设计完成后的设备运行状况,包括正常工作和问题调试。同时,也要描述当所有设备正常工作时智能垃圾回收箱的操作流程。01硬件模块的试验在智能垃圾回收箱的正常运转
    的头像 发表于 05-24 08:10 417次阅读
    智能<b class='flag-5'>垃圾</b>回收箱功能实验

    在STVD书写代码的时候,一写到“{}”就自动顶格了怎么解决?

    在STVD书写代码的时候,一写到“{}”就自动顶格了,好烦哪- -! 不知道哪里可以更改这个设置?
    发表于 05-17 07:34

    垃圾清运以及垃圾处理“神器”让垃圾清运更高效。

    随着城市功能的不断丰富,城市管理工作也从粗放到精细、从纯人工管理到数字化应用逐渐转变。近日,某小区垃圾满溢监测“神器”上线,能够实时监控区内果皮箱的数量、位置、垃圾量情况,让垃圾清运更高
    的头像 发表于 05-13 09:37 340次阅读
    <b class='flag-5'>垃圾</b>清运以及<b class='flag-5'>垃圾</b>处理“神器”让<b class='flag-5'>垃圾</b>清运更高效。

    垃圾中转站无人值守物联网解决方案

    随着城市化程度越来越高,城乡生活垃圾日益增多,生活垃圾中转站运行和管理问题越来越突出,人力成本高、设备故障运维滞后、运营效率差等问题,成为垃圾中转站管理中绕不开的难题。 垃圾中转站通常
    的头像 发表于 04-19 11:22 671次阅读
    <b class='flag-5'>垃圾</b>中转站无人值守物联网解决方案

    智能垃圾回收箱控制系统硬件设计

    智能高效远程控制智能垃圾桶回收箱控制系统硬件部分的选型与设计是整个产品的基础,所有功能的实现都要围绕其进行开发。本章对智能垃圾回收箱控制系统的硬件进行详细设计。智能垃圾回收箱运行时,通过扫描模块进行
    的头像 发表于 04-13 08:10 787次阅读
    智能<b class='flag-5'>垃圾</b>回收箱控制系统硬件设计

    OpenHarmony南向开发案例:【智能垃圾桶】

    智能垃圾桶可以通过数字管家应用来监测垃圾桶当前可用容量,提醒主人及时处理垃圾;通过日程管家可以实现和其他智能设备联动。
    的头像 发表于 04-11 16:01 503次阅读
    OpenHarmony南向开发案例:【智能<b class='flag-5'>垃圾</b>桶】

    瑞萨推出智能垃圾箱解决方案

    随着城市化进程的加速推进,城市垃圾处理问题愈发凸显。传统的垃圾收集方式不仅效率低下,成本高昂,而且往往伴随着严重的环境污染问题。在这一背景下,瑞萨推出的智能垃圾箱解决方案以其环保、高效的特性,为城市
    的头像 发表于 03-16 10:02 931次阅读

    AI垃圾溢出识别摄像机

    随着城市化进程的加快,垃圾处理成为城市管理中的一项重要工作。然而,垃圾桶溢出现象经常发生,给城市环境卫生和市民生活带来不便。为了解决这一问题,AI垃圾溢出识别摄像机应运而生,利用人工智能技术,实现
    的头像 发表于 03-13 11:04 452次阅读
    AI<b class='flag-5'>垃圾</b>溢出识别摄像机

    如何使用Arduino制作智能垃圾

    在这个项目中,我将向您展示如何使用Arduino制作智能垃圾箱,当您带着垃圾接近时,垃圾箱的盖子会自动打开。
    的头像 发表于 02-11 12:22 2869次阅读
    如何使用Arduino制作智能<b class='flag-5'>垃圾</b>箱