2.6 KiB
2.6 KiB
FMS 开发规范
一、构建与测试
- 不要过多封装
- 完成功能后不主动执行构建和测试。
- 只有用户明确要求时,才执行构建、测试或启动服务。
- 交付时说明本次未执行构建和测试。
二、后端接口
- 优先使用现有通用接口完成查询、分页、保存和取号:
/data/loaddata/data/page/data/saveobjt/data/nextid
- 不随意修改通用接口的地址、参数、返回结构和处理逻辑。
- 不随意新增业务专用接口。
- 不新增 services 这类接口或者文件。
- 如果现有通用接口确实无法完成需求,必须先说明原因、拟新增或修改的内容及影响范围,并取得用户确认后再实施。
三、前端实现
- 优先使用项目现有组件和 Antdv Next 组件,不重复实现组件已有的功能。
- 页面存在相同或相近功能时,优先抽取为可复用组件、组合函数或服务方法。
- 抽取复用应以确实减少重复和降低维护成本为前提,不为简单逻辑增加无必要的封装。
- 优先复用现有布局、样式变量和组件能力,以尽量少的 CSS 完成功能。
- 不使用 CSS 重复实现组件已有的尺寸、状态、交互和响应式能力。
- 新增 CSS 应限制在当前组件作用域内,避免影响其他页面。
- 不需要兼容移动端,按桌面端实现即可。
- 表格尽量使用
fms-table组件(项目封装的表格组件),不重复从零实现表格能力。
四、变更范围
- 修改应围绕当前需求,避免无关重构和格式化其他文件。
- 保留已有功能和用户尚未提交的改动。
- 涉及通用接口、公共组件或全局样式的变更,实施前必须先确认影响范围。
五、CSS 规范
- 尽量使用 SCSS:组件样式统一写在
<style scoped lang="scss">中,利用嵌套、变量、mixin 减少重复;全局/公用样式放在src/styles/main.scss(或在此引入的 partial)中,集中管理主题变量(如--fms-*)。 - 以最少的 CSS 完成任务:优先复用 Antdv Next 组件能力、设计变量和已有工具类,能用组件属性或已有 token 解决的就不写样式,不重复实现已有的尺寸/状态/交互。
- 公用样式集中管理:跨页面或同功能重复出现的样式抽到
src/styles/main.scss、共用组件或组合(composable)中,做到「改一处、处处变」;组件内只保留该组件独有、无法共享的样式,并保持scoped。 - 不兼容移动端:按桌面端实现,不写
@media响应式断点;如确有需要,须先与需求方确认。