33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# 开发规范(AI 使用)
|
|
|
|
## 通用原则
|
|
|
|
1. **不搞 placeholder** — 代码中不得出现未实现的占位符、临时桩代码或待填充的 TODO 占位。
|
|
|
|
2. **后端接口优先通用** — 优先使用或设计通用接口,尽量不写特殊接口(为单一业务场景定制的接口)。如需编写特殊接口,必须提前询问用户并获得确认。
|
|
|
|
## 前端代码风格
|
|
|
|
1. **少用语法糖** — 优先使用直白、易读的写法,避免为了炫技而使用语法糖,可读性优先。
|
|
|
|
2. **避免无意义的封装** — 没有必要的抽取就不抽取,不为一层简单调用再包一层方法。例如 `emit('xxx')` 这类直接调用即可,无需再封装成自定义方法。
|
|
|
|
### 查询列表页面设计
|
|
|
|
(待补充)
|
|
|
|
### 详细表单页面设计
|
|
|
|
保存流程方法的命名与顺序参考旧系统风格(仅约定骨架,实现自行设计):
|
|
|
|
1. `handleSave()` — 保存入口
|
|
2. `beforeSave()` — 保存前校验与数据准备
|
|
3. `buildSaveData()` — 构建保存请求数据
|
|
4. `afterSave()` — 保存成功后的处理
|
|
|
|
## 多语言(i18n)约定
|
|
|
|
1. **module 目录下的页面不做多语言翻译** — 模块管理、菜单管理、多语言类型等内部管理页面仅面向 IT 人员,界面文案固定使用中文,不接入 s_i18n 翻译体系、不提供多语言编辑入口。
|
|
2. 面向客户使用的业务页面才需要做多语言翻译(界面文案、s_i18n 键管理、多语言编辑入口)。
|
|
|