06 代码风格与规范

代码风格与规范 #

制定 TypeScript 代码风格规范有助于团队协作和代码维护。

基本概念 #

代码风格包括命名约定、缩进、类型注解位置等。工具如 ESLint 和 Prettier 可强制执行规范。

使用场景 #

  • 团队项目中统一代码风格。
  • 结合 CI/CD 检查风格一致性。
  • 编写可读性高的类型定义。

示例代码 #

命名示例:

// 驼峰式命名
interface UserProfile {
  userName: string;
  emailAddress: string;
}

最佳实践 #

  • 使用 ESLint 的 typescript-eslint 插件。
  • 配置 Prettier 自动格式化。
  • 定义类型时使用 PascalCase,变量使用 camelCase。