TypeScript 风格指南

目录

• 1. 前言
  • 1.1. 简介
  • 1.2. 翻译信息
    • 1.2.1. 上次更新日期
    • 1.2.2. 作者
    • 1.2.3. 原文链接
    • 1.2.4. 中文版链接
    • 1.2.5. 修订历史
• 2. 语法规范
  • 2.1. 标识符
    • 2.1.1. 命名规范
      • 2.1.1.1. 缩写
      • 2.1.1.2. 美元符号 $
      • 2.1.1.3. 类型参数
      • 2.1.1.4. 测试用例
      • 2.1.1.5. _ 前缀与后缀
      • 2.1.1.6. 导入模块
      • 2.1.1.7. 常量
      • 2.1.1.8. 其他
    • 2.1.2. 别名
    • 2.1.3. 命名风格
    • 2.1.4. 描述性命名
  • 2.2. 文件编码
  • 2.3. 注释与文档
    • 2.3.1. 用 JSDoc 还是 注释？
    • 2.3.2. JSDoc 规范
    • 2.3.3. 对所有导出的顶层模块进行注释
    • 2.3.4. 省略对于 TypeScript 而言多余的注释
    • 2.3.5. 不要使用 @override
    • 2.3.6. 注释必须言之有物
    • 2.3.7. 参数属性注释
    • 2.3.8. 函数调用注释
    • 2.3.9. 将文档置于装饰器之前
• 3. 语言特性
  • 3.1. 可见性
  • 3.2. 构造函数
  • 3.3. 类成员
    • 3.3.1. #private 语法
    • 3.3.2. 使用 readonly
    • 3.3.3. 参数属性
    • 3.3.4. 字段初始化
    • 3.3.5. 用于类的词法范围之外的属性
    • 3.3.6. 取值器与设值器（存取器）
  • 3.4. 原始类型与封装类
  • 3.5. 数组构造函数
  • 3.6. 强制类型转换
  • 3.7. 变量
  • 3.8. 异常
  • 3.9. 对象迭代
  • 3.10. 容器迭代
  • 3.11. 展开运算符
  • 3.12. 控制流语句 / 语句块
  • 3.13. switch 语句
  • 3.14. 相等性判断
  • 3.15. 函数声明
  • 3.16. 函数表达式
    • 3.16.1. 在表达式中使用箭头函数
    • 3.16.2. 表达式函数体 和 代码块函数体
    • 3.16.3. 重新绑定 this
    • 3.16.4. 使用箭头函数作为属性
    • 3.16.5. 事件句柄
  • 3.17. 自动分号插入
  • 3.18. @ts-ignore
  • 3.19. 类型断言与非空断言
    • 3.19.1. 类型断言语法
    • 3.19.2. 类型断言和对象字面量
  • 3.20. 成员属性声明
    • 3.20.1. 优化属性访问的兼容性
    • 3.20.2. 优化模块对象导入的兼容性
    • 3.20.3. 例外情况
  • 3.21. 枚举
  • 3.22. debugger 语句
  • 3.23. 装饰器
• 4. 代码管理
  • 4.1. 模块
    • 4.1.1. 导入路径
    • 4.1.2. 用 命名空间 还是 模块？
  • 4.2. 导出
    • 4.2.1. 导出可见性
    • 4.2.2. 可变导出
    • 4.2.3. 容器类
  • 4.3. 导入
    • 4.3.1. 选择模块导入还是解构导入？
    • 4.3.2. 重命名导入
    • 4.3.3. import type 和 export type
  • 4.4. 根据特征组织代码
• 5. 类型系统
  • 5.1. 类型推导
    • 5.1.1. 返回类型
  • 5.2. Null 还是 Undefined ？
    • 5.2.1. 可空/未定义类型别名
    • 5.2.2. 可选参数 还是 undefined 类型？
  • 5.3. 结构类型 与 指名类型
  • 5.4. 接口 还是 类型别名？
  • 5.5. Array<T> 类型
  • 5.6. 索引类型 {[key: string]: number}
  • 5.7. 映射类型与条件类型
  • 5.8. any 类型
    • 5.8.1. 提供一个更具体的类型
    • 5.8.2. 使用 unknown 而非 any
    • 5.8.3. 关闭 Lint 工具对 any 的警告
  • 5.9. 元组类型
  • 5.10. 包装类型
  • 5.11. 只有泛型的返回类型
• 6. 一致性
  • 6.1. 目标