烂代码的项目在 GitHub 上火了...
如果我们键入的东西越少,那么就有越多的时间去思考代码逻辑等问题。
如下所示,「Good」表示遵循该规则的示例,Bad 表示没遵循该规则的示例。
我们需要混合命名方法与变量,这样才能体现命名的多样性。
反正代码都看得懂,为什么要写注释?
或者说,反正没人看我的代码,为什么要写注释?
如果你违反了第三条规则,那么至少写注释需要用你的母语或者其它语言。
如果你的母语是英语,那么你也算违反了这条规则。
既然编程语言绝大多数都是用英文,那么为什么不用其它语言注释一下?
同样,为了代码的多样性,我们需要尽可能混合不同的格式,例如单引号或双引号。
如果它们的语义相同,那就应该混用。
如果一系列参数与方法都是一起实现的,那么代码也要写在一起。
当你发现某些错误时,其他人不需要了解它,因此不需要打印出日志或 Traceback。
以防万一,我们需要创建一些备用变量,在需要时随时调用它们。
一般不要指定变量类型或者经常做类型检查,无类型才是最好的类型。
你需要准备一些运行不到的代码(unreachable code),它们可以作为你的「Plan B」。
如果代码有一些嵌套结构,或者说缩进空行的结构,三角法则是最漂亮的。
我们需要避免采用缩进,因为缩进会使复杂代码在编辑器中占用更多的空间。
如果一定要采用缩进,那么就使用混合缩进策略。
当然,这种策略在 Python 中是行不通的,因为它靠缩进来确定代码结构。
每一次要安装新库时,更新已有的依赖项。
为什么要维持之前的版本呢,我们需要时刻保持最新的第三方代码库。
不要将程序整体逻辑分割为一些代码块,要是 IDE 突然不行了,它找不到必要的文件或函数怎么办。
因此把代码写在一个主体函数中,并且不再维护额外的函数导入或代码文件,那么这样的方法是最稳定的。
单个文件一万行代码是没问题的,单个函数一千行代码也是没问题的。
按你的想法写代码,尤其是在小团队中,毕竟这是「自由」准则。
在写代码的过程中,经常会产生很多测试代码。
这些代码也是非常重要的资料,因此不能删除掉,最多只能注释掉。
来源 | 网络
标签: