垃圾代码应该怎么写
在 github 上有一个新项目，它描述了「最佳垃圾代码」的十九条关键准则。从变量命名到注释编写。这些准则将指导你写出最亮眼的烂代码。
为了保持与原 github 项目一致的风格，下文没有进行转换。读者们可以以相反的角度来理解所有观点，这样就能完美避免写出垃圾代码。
当然，以下十九条垃圾代码书写准则并没有面面俱到，如果读者们发现有一些难以忍受的烂代码习惯，也可以留言发表你的看法。
这是一个你的项目应该遵循的垃圾代码书写准则的列表：
以一种代码已经被混淆的方式命名变量
如果我们键入的东西越少，那么就有越多的时间去思考代码逻辑等问题。
变量/函数混合命名风格
为不同庆祝一下。
good
let wwidth = 640;let w_height = 480; bad
let windowwidth = 640;let windowheight = 480; 不要写注释
反正没人会读你的代码。
good
const cdr = 700; bad
更多时候，评论应该包含一些“为什么”，而不是一些“是什么”。如果“什么”在代码中不清楚，那么代码可能太混乱了。
// 700ms的数量是根据ux a/b测试结果进行经验计算的。// @查看: const callbackdebouncerate = 700; 使用母语写注释
如果您违反了“无注释”原则，那么至少尝试用一种不同于您用来编写代码的语言来编写注释。如果你的母语是英语，你可能会违反这个原则。
good
// закриваємо модальне віконечко при виникненні помилки.togglemodal(false); bad
// 隐藏错误弹窗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){n=n.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; }, {}) 不要处理错误
无论何时发现错误，都没有必要让任何人知道它。没有日志，没有错误弹框。
good
try { // 意料之外的情况。} catch (error) { // tss... } bad
try { // 意料之外的情况。} catch (error) { seterrormessage(error.message); // and/or logerror(error);} 广泛使用全局变量
全球化的原则。
good
let x = 5;function square() { x = x ** 2;}square(); // 现在x是25 bad
let x = 5;function square(num) { return num ** 2;}x = square(x); // 现在x是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;} 如果语言允许，不要指定类型和/或不执行类型检查。 good
function sum(a, b) { return a + b;}// 在这里享受没有注释的快乐const guesswhat = sum([], {}); // -> [object object]const guesswhatagain = sum({}, []); // -> 0 bad
function sum(a: number, b: number): ?number { // 当我们在js中不做置换和/或流类型检查时，覆盖这种情况。 if (typeof a !== 'number' && typeof b !== 'number') { return undefined; } return a + b;}// 这个应该在转换/编译期间失败。const guesswhat = sum([], {}); // -> undefined 你应该有不能到达的代码
这是你的 “plan b”.
good
function square(num) { if (typeof num === 'undefined') { return undefined; } else { return num ** 2; } return null; // 这就是我的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) { } }} 混合缩进
避免缩进，因为它们会使复杂的代码在编辑器中占用更多的空间。如果你不喜欢回避他们，那就和他们捣乱。
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.json bad
$ ls -lapackage.jsonpackage-lock.json 函数长的比短的好
不要把程序逻辑分成可读的部分。如果ide的搜索停止，而您无法找到所需的文件或函数，该怎么办？
一个文件中10000行代码是ok的。
一个函数体有1000行代码是ok的。
在一个‘ service.js ’ 中处理许多服务（第三方库和内部库、一些工具、手写的数据库orm和jquery滑块）？ 这是ok的。
不要测试你的代码
这是重复且不需要的工作。
避免代码风格统一
编写您想要的代码，特别是在一个团队中有多个开发人员的情况下。这是“自由”原则。
构建新项目不需要 readme 文档
一开始我们就应该保持。
保存不必要的代码
不要删除不用的代码，最多注释掉。
原文标题：github这份垃圾代码书写准则，火了
文章出处：【微信公众号：strongerhuang】欢迎添加关注！文章转载请注明出处。
迅远RFID无障碍通道门实现无障碍通道人员及物品的跟踪管控
英国陆军订购哈里斯T7拆弹机器人
区块链在供应链物流中的影响
防爆烟温复合探测器的特点和工作原理是怎样的
iphone8什么时候上市？iphone8最新消息：iphone8产能不足，网友大呼：我选三星note8！
垃圾代码应该怎么写
SPINAND UBI离线烧录开发指南
两款三星手机正在做HTML5的基准测试
关于骨传导耳机和气传导耳机的区别，你可能还不知道!
基于嵌入式Internet技术实现网络打印服务器系统的软硬件设计
飞机的技术用在车上！奔驰宝马都没用TA就用了，自动驾驶真那么神？
腾冲：智慧灯光照亮文明之路
TD-SCDMA规划的特点
这么牛的氧化皮去除机 不是亲眼见到都不敢相信
固定资产案例分享
SMT模板是怎样的一回事
晶体管和电子管的区别
反向放大电路设计
降压型DC-DC开关调节器驱动PA方案
等离子显示器输入接口简介
为了保持与原 github 项目一致的风格，下文没有进行转换。读者们可以以相反的角度来理解所有观点，这样就能完美避免写出垃圾代码。
当然，以下十九条垃圾代码书写准则并没有面面俱到，如果读者们发现有一些难以忍受的烂代码习惯，也可以留言发表你的看法。
这是一个你的项目应该遵循的垃圾代码书写准则的列表：
以一种代码已经被混淆的方式命名变量
如果我们键入的东西越少，那么就有越多的时间去思考代码逻辑等问题。
变量/函数混合命名风格
为不同庆祝一下。
good
let wwidth = 640;let w_height = 480; bad
let windowwidth = 640;let windowheight = 480; 不要写注释
反正没人会读你的代码。
good
const cdr = 700; bad
更多时候，评论应该包含一些“为什么”，而不是一些“是什么”。如果“什么”在代码中不清楚，那么代码可能太混乱了。
// 700ms的数量是根据ux a/b测试结果进行经验计算的。// @查看: const callbackdebouncerate = 700; 使用母语写注释
如果您违反了“无注释”原则，那么至少尝试用一种不同于您用来编写代码的语言来编写注释。如果你的母语是英语，你可能会违反这个原则。
good
// закриваємо модальне віконечко при виникненні помилки.togglemodal(false); bad
// 隐藏错误弹窗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){n=n.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; }, {}) 不要处理错误
无论何时发现错误，都没有必要让任何人知道它。没有日志，没有错误弹框。
good
try { // 意料之外的情况。} catch (error) { // tss... } bad
try { // 意料之外的情况。} catch (error) { seterrormessage(error.message); // and/or logerror(error);} 广泛使用全局变量
全球化的原则。
good
let x = 5;function square() { x = x ** 2;}square(); // 现在x是25 bad
let x = 5;function square(num) { return num ** 2;}x = square(x); // 现在x是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;} 如果语言允许，不要指定类型和/或不执行类型检查。 good
function sum(a, b) { return a + b;}// 在这里享受没有注释的快乐const guesswhat = sum([], {}); // -> [object object]const guesswhatagain = sum({}, []); // -> 0 bad
function sum(a: number, b: number): ?number { // 当我们在js中不做置换和/或流类型检查时，覆盖这种情况。 if (typeof a !== 'number' && typeof b !== 'number') { return undefined; } return a + b;}// 这个应该在转换/编译期间失败。const guesswhat = sum([], {}); // -> undefined 你应该有不能到达的代码
这是你的 “plan b”.
good
function square(num) { if (typeof num === 'undefined') { return undefined; } else { return num ** 2; } return null; // 这就是我的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) { } }} 混合缩进
避免缩进，因为它们会使复杂的代码在编辑器中占用更多的空间。如果你不喜欢回避他们，那就和他们捣乱。
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.json bad
$ ls -lapackage.jsonpackage-lock.json 函数长的比短的好
不要把程序逻辑分成可读的部分。如果ide的搜索停止，而您无法找到所需的文件或函数，该怎么办？
一个文件中10000行代码是ok的。
一个函数体有1000行代码是ok的。
在一个‘ service.js ’ 中处理许多服务（第三方库和内部库、一些工具、手写的数据库orm和jquery滑块）？ 这是ok的。
不要测试你的代码
这是重复且不需要的工作。
避免代码风格统一
编写您想要的代码，特别是在一个团队中有多个开发人员的情况下。这是“自由”原则。
构建新项目不需要 readme 文档
一开始我们就应该保持。
保存不必要的代码
不要删除不用的代码，最多注释掉。
原文标题：github这份垃圾代码书写准则，火了
文章出处：【微信公众号：strongerhuang】欢迎添加关注！文章转载请注明出处。
迅远RFID无障碍通道门实现无障碍通道人员及物品的跟踪管控
英国陆军订购哈里斯T7拆弹机器人
区块链在供应链物流中的影响
防爆烟温复合探测器的特点和工作原理是怎样的
iphone8什么时候上市？iphone8最新消息：iphone8产能不足，网友大呼：我选三星note8！
垃圾代码应该怎么写
SPINAND UBI离线烧录开发指南
两款三星手机正在做HTML5的基准测试
关于骨传导耳机和气传导耳机的区别，你可能还不知道!
基于嵌入式Internet技术实现网络打印服务器系统的软硬件设计
飞机的技术用在车上！奔驰宝马都没用TA就用了，自动驾驶真那么神？
腾冲：智慧灯光照亮文明之路
TD-SCDMA规划的特点
这么牛的氧化皮去除机 不是亲眼见到都不敢相信
固定资产案例分享
SMT模板是怎样的一回事
晶体管和电子管的区别
反向放大电路设计
降压型DC-DC开关调节器驱动PA方案
等离子显示器输入接口简介