牛马程序员，强推《屎山代码风格指南》
屎山代码风格指南
牛马程序员，强推《屎山代码风格指南》，github 开源地址：点击进入
对标谷歌《JavaScript 风格指南》，地址：点击进入
规则 1，以混淆方式命名变量
举例：
js
// 这是一种好的方式
let a = 10js
// 这是一种比较糟糕的方式
let age = 20规则 2，混合命名
举例：
js
// 这是一种好的方式
let wWidth = 640
let w_width = 640js
// 这是一种糟糕的方式
let windowWidth = 640
let windowHeight = 480规则 3，不要写注释#
js
// 这是一种好的反噬
const cdr = 700js
// 700ms的数量是根据UX A/B测试结果进行经验计算的。
// @查看: <详细解释700的一个链接>
const callbackDebounceRate = 700规则 4，非母语注释#
如果你手贱，确实想写注释，你已经违背了规则 3，在这种情况下，规则 4 一定要遵守，写注释用非母语，提升别人看注释的门槛，例如：你的母语是中文，你写注释就用法语或者俄语
js
// 这是一种好的方式
// Закриваємо модальне віконечко при виникненні помилки.
toggleModal(false)js
// 这是一种比较糟糕的方式
// 隐藏错误弹窗
toggleModal(false)规则 5，尽可能把代码写成一行#
把代码写在一行才显得更牛逼,别人写 20 行，你一行就搞定了
// 这是一种好的方式
document.location.search.replace(/(^\?)/,'').split('&').reduce(function(o,n){n=n.split('=');o[n[0]]=n[1];return o},{})js
// 这是比较糟糕的方式
document.location.search
.replace(/(^\?)/, '')
.split('&')
.reduce((searchParams, keyValuePair) => {
keyValuePair = keyValuePair.split('=')
searchParams[keyValuePair[0]] = keyValuePair[1]
return searchParams
}, {})规则 6，不要处理错误#
无论在什么时候，发现报错了都不要处理它，也不要告诉任何人这里有错误，这样会显得你水平很低，写的代码总是报错
js
// 这是比较好的方式
try {
// 意料之外的情况。
} catch (error) {
// tss...
}js
// 这是一种糟糕的方式
try {
// 意料之外的情况。
} catch (error) {
setErrorMessage(error.message)
// and/or
logError(error)
}规则 7，大量使用全局变量#
使用全局变量，想在哪儿用就在哪儿用，这样很方便
js
// 这是一种好的方式
let x = 5
function square() {
x = x ** 2
}
square() // 现在x是25js
// 这是一种比较糟糕的方式
let x = 5
function square(num) {
return num ** 2
}
x = square(x) // 现在x是25规则 8，创建你不会使用的变量#
为了方便以后使用，预留一些变量，以防万一
js
function sum(a, b, c) {
// 这是一种好的方式
const timeout = 1300
const result = a + b
return a + b
}js
// 这是一种糟糕的方式
function sum(a, b) {
return a + b
}规则 9，类型可选，就别写#
以 TS 为例，可以不用规定类型，那就别写类型
js
// 这是一种好的方式
function sum(a, b) {
return a + b
}
// 在这里享受没有注释的快乐
const guessWhat = sum([], {}) // -> "[object Object]"
const guessWhatAgain = sum({}, []) // -> 0js
// 这是一种糟糕的方式
function sum(a: number, b: number): ?number {
// 当我们在JS中不做置换和/或流类型检查时，覆盖这种情况。
if (typeof a !== 'number' && typeof b !== 'number') {
return undefined
}
return a + b
}
// 这个应该在转换/编译期间失败。
const guessWhat = sum([], {}) // -> undefined规则 10，写永远无法到达的代码#
js
// 这是比较好的方式
function square(num) {
if (typeof num === 'undefined') {
return undefined
} else {
return num ** 2
}
return null // 这就是我的"Plan B".
}js
// 这是一种比较糟糕的方式
function square(num) {
if (typeof num === 'undefined') {
return undefined
}
return num ** 2
}规则 11，三角法则#
js
// 这是一种好的方式
function someFunction() {
if (condition1) {
if (condition2) {
asyncFunction(params, (result) => {
if (result) {
for (;;) {
if (condition3) {
}
}
}
})
}
}
}js
// 这是一种糟糕的方式
async function someFunction() {
if (!condition1 || !condition2) {
return
}
const result = await asyncFunction(params)
if (!result) {
return
}
for (;;) {
if (condition3) {
}
}
}规则 12，混合缩进#
避免缩进，因为它们会使复杂的代码在编辑器中占用更多的空间
// 这种方式就很好
const fruits = ['apple',
'orange', 'grape', 'pineapple'];
const toppings = ['syrup', 'cream',
'jam',
'chocolate'];
const desserts = [];
fruits.forEach(fruit => {
toppings.forEach(topping => {
desserts.push([
fruit,topping]);
});})js
// 这种方式很糟糕
const fruits = ['apple', 'orange', 'grape', 'pineapple']
const toppings = ['syrup', 'cream', 'jam', 'chocolate']
const desserts = []
fruits.forEach((fruit) => {
toppings.forEach((topping) => {
desserts.push([fruit, topping])
})
})规则 13，不要锁版本#
永远使用最新的版本，这看起来很高级
规则 14，函数长的比短的好#
一个函数写一千行代码，不要去拆分
规则 15，不要写测试#
写测试是测试工程师做的事情，千万不要写测试
规则 16，避免风格统一#
在团队里面要有个性，尽量使用和团队其他人不统一的代码风格
规则 17，不要删除无用的代码#
把无用的代码注释掉，但是千万别删掉，万一后面要用到呢
规则 18，不要写 README 文档#
构建新项目的时候，不要写 README 文档，让用户自己猜
注意#
本代码风格出自一个开源项目，github 开源地址：点击进入，我们觉得这个代码风格非常值得借鉴，特此说明
Comments | NOTHING