hookehuyr

docs: 更新项目文档,补充代码编写规范和工作流程

Showing 1 changed file with 16 additions and 0 deletions
...@@ -142,3 +142,19 @@ pnpm build:h5 # 构建H5端生产包 ...@@ -142,3 +142,19 @@ pnpm build:h5 # 构建H5端生产包
142 - 默认请求参数在 `src/utils/config.js` 中配置 142 - 默认请求参数在 `src/utils/config.js` 中配置
143 - 所有后端请求统一通过 `/srv/?a=...` 格式的接口转发 143 - 所有后端请求统一通过 `/srv/?a=...` 格式的接口转发
144 - 固定自定义参数:`f='reserve'``client_name='智慧西园寺'` 144 - 固定自定义参数:`f='reserve'``client_name='智慧西园寺'`
145 +
146 +## 代码编写
147 +
148 +### 组件编写
149 +- 所有组件均基于 NutUI 4.x 组件库编写
150 +- 组件文件统一存放于 `src/components/` 目录,遵循 `[组件名称].vue` 命名规范
151 +- 组件 props 定义清晰,注释详细,符合 Vue 组件规范
152 +
153 +### 功能编写
154 +- 对于复杂逻辑需要进行封装,避免在页面中直接编写复杂逻辑
155 +- 封装逻辑统一存放于 `src/composables/` 目录,遵循 `use[功能名称].js` 命名规范
156 +- 封装函数注释详细,参数/返回值/异常情况均需说明
157 +
158 +## 代码风格
159 +
160 +## 工作流程
......