手机网站排名怎么做,海口建设网站的公司哪家好,wordpress发送注册邮件失败,做网站找图片在 GitHub 上有一个项目#xff0c;它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写#xff0c;这些准则将指导你写出最亮眼的烂代码。
为了保持与原 GitHub 项目一致的风格#xff0c;下文没有进行转换。读者们可以以相反的角度来理解所有观点#xff0…在 GitHub 上有一个项目它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写这些准则将指导你写出最亮眼的烂代码。
为了保持与原 GitHub 项目一致的风格下文没有进行转换。读者们可以以相反的角度来理解所有观点这样就能完美避免写出垃圾代码。
项目地址https://github.com/trekhleb/state-of-the-art-shitcode
当然以下十九条垃圾代码书写准则并没有面面俱到如果读者们发现有一些难以忍受的烂代码习惯也可以发表你的看法。 第一条打字越少越好
如果我们键入的东西越少那么就有越多的时间去思考代码逻辑等问题。如下所示「Good」表示遵循该规则的示例Bad 表示没遵循该规则的示例。
Good
let a 42;Bad
let age 42;第二条变量/函数混合命名风格
我们需要混合命名方法与变量这样才能体现命名的多样性。
Good
let wWidth 640;
let w_height 480;Bad
let windowWidth 640;
let windowHeight 480;第三条不要写注释
反正代码都看得懂为什么要写注释或者说反正没人看我的代码为什么要写注释
Good
const cdr 700;Bad
More often comments should contain some ‘why’ and not some ‘what’. If the ‘what’ is not clear in the code, the code is probably too messy.
// The number of 700ms has been calculated empirically based on UX A/B test results.
// see: link to experiment or to related JIRA task or to something that explains number 700 in details
const callbackDebounceRate 700;第四条使用母语写注释
如果你违反了第三条规则那么至少写注释需要用你的母语或者其它语言。如果你的母语是英语那么你也算违反了这条规则。既然编程语言绝大多数都是用英文那么为什么不用其它语言注释一下
Good
// Закриваємо модальне віконечко при виникненні помилки.
toggleModal(false);Bad
// Hide modal window on error.
toggleModal(false);第五条尽可能混合不同的格式
同样为了代码的多样性我们需要尽可能混合不同的格式例如单引号或双引号。如果它们的语义相同那就应该混用。
Good
let i [tomato, onion, mushrooms];
let d [ ketchup, mayonnaise ];Bad
let ingredients [tomato, onion, mushrooms];
let dressings [ketchup, mayonnaise];第六条尽可能把代码写成一行
如果一系列参数与方法都是一起实现的那么代码也要写在一起。
Good
document.location.search.replace(/(^\?)/,).split().reduce(function(o,n){nn.split();o[n[0]]n[1];return o},{})Bad
document.location.search.replace(/(^\?)/, ).split().reduce((searchParams, keyValuePair) {keyValuePair keyValuePair.split();searchParams[keyValuePair[0]] keyValuePair[1];return searchParams;},{}
)第七条发现错误要保持静默
当你发现某些错误时其他人不需要了解它因此不需要打印出日志或 Traceback。
Good
try {// Something unpredictable.
} catch (error) {// tss...
}Bad
try {// Something unpredictable.
} catch (error) {setErrorMessage(error.message);// and/orlogError(error);
}第八条广泛使用全局变量
使用全局变量是面向「全球化」不可或缺的部分。
Good
let x 5;function square() {x x ** 2;
}square(); // Now x is 25.Bad
let x 5;function square(num) {return num ** 2;
}x square(x); // Now x is 25.第九条构建备用变量
以防万一我们需要创建一些备用变量在需要时随时调用它们。
Good
function sum(a, b, c) {const timeout 1300;const result a b;return a b;
}Bad
function sum(a, b) {return a b;
}第十条Type 使用需谨慎
一般不要指定变量类型或者经常做类型检查无类型才是最好的类型。
Good
function sum(a, b) {return a b;
}// Having untyped fun here.
const guessWhat sum([], {}); // - [object Object]
const guessWhatAgain sum({}, []); // - 0Bad
function sum(a: number, b: number): ?number {// Covering the case when we dont do transpilation and/or Flow type checks in JS.if (typeof a ! number typeof b ! number) {return undefined;}return a b;
}// This one should fail during the transpilation/compilation.
const guessWhat sum([], {}); // - undefined第十一条准备「Plan B」
你需要准备一些运行不到的代码unreachable code它们可以作为你的「Plan B」。
Good
function square(num) {if (typeof num undefined) {return undefined;}else {return num ** 2;}return null; // This is my Plan B.
}Bad
function square(num) {if (typeof num undefined) {return undefined;}return num ** 2;
}第十二条嵌套的三角法则
如果代码有一些嵌套结构或者说缩进空行的结构三角法则是最漂亮的。
Good
function someFunction() {if (condition1) {if (condition2) {asyncFunction(params, (result) {if (result) {for (;;) {if (condition3) {}}}})}}
}Bad
async function someFunction() {if (!condition1 || !condition2) {return;}const result await asyncFunction(params);if (!result) {return;}for (;;) {if (condition3) {}}
}第十三条混合缩进
我们需要避免采用缩进因为缩进会使复杂代码在编辑器中占用更多的空间。如果一定要采用缩进那么就使用混合缩进策略。当然这种策略在 Python 中是行不通的因为它靠缩进来确定代码结构。
Good
const fruits [apple,orange, grape, pineapple];const toppings [syrup, cream, jam, chocolate];
const desserts [];
fruits.forEach(fruit {
toppings.forEach(topping {desserts.push([
fruit,topping]);});})Bad
const fruits [apple, orange, grape, pineapple];
const toppings [syrup, cream, jam, chocolate];
const desserts [];fruits.forEach(fruit {toppings.forEach(topping {desserts.push([fruit, topping]); });
})第十四条不要锁住依赖项
每一次要安装新库时更新已有的依赖项。为什么要维持之前的版本呢我们需要时刻保持最新的第三方代码库。
Good
$ ls -lapackage.jsonBad
$ ls -lapackage.json
package-lock.json第十五条始终将布尔值命名为 flag
为同事留出空间来思考布尔值的含义
不错
let flag true;不好
let isDone false;
let isEmpty false;第十六条长函数比短函数好
不要将程序整体逻辑分割为一些代码块要是 IDE 突然不行了它找不到必要的文件或函数怎么办。因此把代码写在一个主体函数中并且不再维护额外的函数导入或代码文件那么这样的方法是最稳定的。
单个文件一万行代码是没问题的单个函数一千行代码也是没问题的。
第十七条代码不需要做特定测试
这些测试通常是重复且无意义的工作。
第十八条尽量避免重复代码
按你的想法写代码尤其是在小团队中毕竟这是「自由」准则。
第十九条构建新项目不需要 README 文档
在项目前期我们可以暂时保持这种状态。
第二十条保存不必要的代码
在写代码的过程中经常会产生很多测试代码。这些代码也是非常重要的资料因此不能删除掉最多只能注释掉。
来源 | 机器之心 | Jack-Cui
