概述
当开发 TypeScript 项目时，良好的文件命名和代码规范是非常重要的。它们不仅可以提高代码的可读性和可维护性，还能帮助团队成员更好地理解和协作开发。通过遵循一致的命名约定和编码规范，可以减少代码错误、改善代码的一致性，并为项目的可扩展性和可维护性奠定基础。
开始
文件命名：
- TypeScript 声明文件的扩展名为
.d.ts。 - 入口文件通常命名为
index.ts，用于导出模块或启动应用程序。 - 模块文件应根据其功能或目的进行命名，例如
utils.ts、apiClient.ts等。
代码规范：
- 使用驼峰命名法（camelCase）来命名变量、函数和方法。例如：
myVariable、calculateTotal。 - 类名使用帕斯卡命名法（PascalCase）。例如：
MyClass、UserService。 - 使用清晰、具有描述性的名称，使代码易于理解。
- 遵循一致的缩进和代码格式 。通常使用 2 或 4 个空格进行缩进，并在代码块之间添加适当的空行和垂直间距。
- 使用强类型声明，并尽可能使用 TypeScript 的类型系统来提供静态类型检查。
- 在必要时添加注释来解释代码的用途、实现细节或注意事项。
- 遵循 SOLID 原则和其他软件工程最佳实践，如单一职责原则、依赖倒置原则等。
- 分离关注点，将代码分成逻辑模块、函数和类，以提高代码的可维护性和可测试性。