# TypeScript 代码风格指南与代码约定
# 1. 命名
| 类型 | 风格 |
|---|---|
| 变量 | cameCase(小驼峰) |
| 函数 | cameCase |
| 类 | PascalCase(大驼峰) |
| 类属性 | cameCase |
| 类方法 | cameCase |
| 接口 | PascalCase |
| 类型别名 | PascalCase |
| 命名空间 | PascalCase |
| 枚举 | PascalCase |
| 枚举成员 | PascalCase |
# 2. null 和 undefined
如果函数返回类型为 对象 | null,建议改成 { valid: boolean, value?: obj }:
function getObj(type: string) {
if (!type) {
return null
}
return { name: '张三' };
}
// -- 修改后
interface Obj {
valid: boolean;
value?: { name: string }
}
function getObj2(type: string): Obj {
if (!type) {
return { valid: false };
}
return { valid: false, value: { name: '张三' } };
}
使用 x == undefined / x != undefined 来检查 x 是否为 null / undefined
# 3. 格式化
引号:
- 使用单引号
空格:
- 2 个空格
分号:
- 显式使用分号
数组:
- 使用
let x: number[]而不是let x: Array<number>
上一篇: 下一篇:
本章目录