Skip to content

代码风格规范

基本格式

  • 缩进:2 个空格(TypeScript / JavaScript / CSS / HTML 统一)
  • 字符串:JS/TS 使用单引号,JSON 和 HTML 属性使用双引号
  • 行末无多余空格;文件末尾保留一个空行
  • 单行最大长度:100 字符

命名规范

场景风格示例
变量 / 函数camelCasegetUserInfo
类 / 接口 / 类型PascalCaseUserProfile
常量UPPER_SNAKE_CASEMAX_RETRY_COUNT
文件(非组件)kebab-caseuser-profile.ts
React/Vue 组件文件PascalCaseUserCard.tsx

TypeScript 规范

  • 函数必须明确标注返回类型
  • 禁止使用 any;不确定类型时优先用 unknown
  • 对象结构用 interface,联合类型 / 工具类型用 type
  • 不可变属性加 readonly 修饰

代码组织

  • 每个文件只负责单一职责
  • import 顺序:Node 内置 → 第三方 → 本地模块,各组之间空一行
  • 相关逻辑放在一起,用空行分隔不同关注点
  • 避免超过 3 层的条件 / 回调嵌套

Power By 数字海南