typescript 代码规范

遵循以下 typescript 代码规范有助于提高代码可读性、可维护性和可扩展性：使用空格缩进（建议 2 个空格）。使用花括号括起代码块。可选使用分号结尾语句。采用驼峰式命名法（小驼峰式：变量、方法、属性；大驼峰式：类、接口、枚举）。为所有变量和函数参数添加类型标注。使用缩写语法（e.g. number[]）。使用接口定义对象形状，使用类型别名创建新类型。使用 readonly 标记不可变类型。私有类成员以 _ 开头，构造

TypeScript 代码规范

前言

TypeScript 是一种流行的 JavaScript 超集语言，以其类型系统和可移植性而闻名。维护一致的代码风格对于确保 TypeScript 代码库的可读性、可维护性和可扩展性至关重要。本指南提供了 TypeScript 代码规范，旨在帮助开发人员编写符合行业最佳实践的代码。

代码格式化

• 使用空格进行缩进（建议使用 2 个空格）。
• 使用花括号将代码块括起来，即使只有一行代码。
• 使用分号结尾语句（可选，但建议使用）。

命名约定

• 使用驼峰式命名法（小驼峰式用于变量、方法和属性；大驼峰式用于类、接口和枚举）。
• 变量和属性以小写字母开头。
• 类和接口以大写字母开头。

类型标注

• 为所有变量和函数参数添加类型标注。
• 对于函数返回值，仅在必要时添加类型标注。
• 使用缩写语法（e.g. number[] 而不是 Array）。

接口和类型

• 使用接口定义对象形状，而不是使用 any 类型。
• 使用类型别名创建一个新的类型，而不是重复定义相同的类型。
• 使用 readonly 关键字标记不可变类型。

类

• 私有成员以 _ 开头。
• 构造函数应命名为 constructor。
• 静态成员应以 static 关键字标记。

函数

• 函数应尽可能简短。
• 避免嵌套函数。
• 使用默认参数值而不是重载。

注释

• 为复杂的代码提供有用的注释。
• 使用 Markdown 语法编写多行注释。
• 避免使用过多的注释。

其他

• 使用缩进敏感的编辑器（e.g. Visual Studio Code）。
• 使用自动代码格式化工具（e.g. Prettier）。
• 遵循团队或项目的特定代码规范（如果适用）。