Z
ZeniCore
/文档中心
文档编码规范

编码规范

2026-04-21 v1.0.0

编码规范

TypeScript 规范

  • 禁止使用 any,必须明确类型声明
  • 优先使用 interface 定义对象类型
  • 使用 type 定义联合类型、工具类型
  • 函数返回值类型必须明确声明

Vue 组件规范

  • 必须使用 <script setup lang="ts">
  • 禁止使用 Options API
  • Props/Emits 必须用 defineProps/defineEmits 声明类型

命名规范

类型规范示例
组件文件PascalCaseUserDialog.vue
组合式函数use + PascalCaseuseUserList.ts
工具函数camelCaseformatDate.ts
Store 文件camelCaseuser.ts
路由路径kebab-case/user-manage
常量UPPER_SNAKE_CASEAPI_BASE_URL

样式规范

  • 优先使用 Tailwind CSS 原子类
  • 复杂样式使用 CSS 变量
  • 禁止内联样式
  • 组件样式必须使用 scoped