-
命名规范:
- 类名使用 PascalCase(即每个单词首字母大写).
- 变量名和函数名使用 camelCase(即除了首个单词,其他单词首字符大写).
- 文件名使用 kebab-case(即将单词用短横线分隔).
- 接口名使用 I 前缀,枚举名使用 E 前缀.
- 类型别名和 泛型类型使用 PascalCase.
-
类型:
- 对于简单的类型,使用内置 TypeScript 类型(例如 string、number).
- 对于复杂的类型,使用接口.
- 如果声明变量时没有指定类型,则尽可能给出类型.
- 在代码中使用 const 替代 readonly.
-
引用:
- 在文件开头先 import 导入需要的文件.
- 一个 import 语句只引用一个模块.
- 避免使用命名空间,而是使用 ES6 的 export 和 import 语句.
-
注释:
- 随缘 根据自己的习惯, 使用中文
-
缩进:
- 使用 4 个空格缩进.
- 不要使用 tab 字符.
-
格式:
- 将大括号放在同一行的语句块中.
- 在关键字前后加上空格(例如 if 和 else).
- 在函数名和调用之间使用空格(例如 function foo()).
- 使用字符串模板代替字符串连接.
-
其他规范:
- 避免使用 any 类型.
- 使用默认参数而不是函数重载.
- 避免使用无意义的变量名.
- 遵循单一职责原则,一个类、一个组件只负责一项功能.
- 优先使用对象解构来获取变量.
- 避免代码冗余,将相似的代码封装到函数或组件中.