Appearance
变量命名
变量、字段命名,应该包含它所对应的真实含义。这样更容易在代码里搜索,并且其他人看到这些变量,也更容易理解。
错误的示范
ts
let daysSLV = 10
let y = new Date().getFullYear()
let ok
if (user.age > 30) {
ok = true
}
正确的示范
ts
const MAX_AGE = 30
let daysSinceLastVisit = 10
let currentYear = new Date().getFullYear()
const isUserOlderThanAllowed = user.age > MAX_AGE
不要在变量名中加入不必要的单词
错误的示范
ts
let nameValue
let theProduct
正确的示范
ts
let name
let product
不要强迫开发者去记住变量名的上下文
错误的示范
ts
const users = ['John', 'Marco', 'Peter']
users.forEach((u) => {
doSomething()
doSomethingElse()
register(u)
})
正确的示范
ts
const users = ['John', 'Marco', 'Peter']
users.forEach((user) => {
doSomething()
doSomethingElse()
register(user)
})
不要在变量名中添加多余的上下文信息
错误的示范
ts
const user = {
userName: 'John',
userSurname: 'Doe',
userAge: '28',
}
user.userName
正确的示范
ts
const user = {
name: 'John',
surname: 'Doe',
age: '28',
}
user.name