中心前端开发规范:https://doc.gz.cvte.cn/code/javascript.html
## 代码规范
### 一、命名规范
- 文件名、目录名:使用小驼峰,不使用短线和空格;组件名使用大驼峰;
- 常量:大写+短线,必须使用 const 声明;
- 变量:小驼峰,尽量使用英文将变量的作用描述清楚;避免错别字;
### 二、编码规范
- 注释:文件注释在顶部使用双斜线描述当前文件;变量名、方法名、类名使用 /** */ 进行注释,以自动生成 JSDoc ;
- 多个方法之间需要有空行;
- 空行不允许有空格;
- 文件末尾需要有单独一行空行;
### 三、业务代码规范
- 如果是纯函数、工具类函数,优先考虑放入 utils.js 、 tools.js 函数库文件中,方便复用。不要作为组件的内部函数。(例如 formatDate, formatFileSize 等);
- 被两个以上模块引入的模块/组件,需要提升到 src/component/ 目录下;
## UI 规范
### 1. 常用列宽配置
列 | 宽度(px) |
---|---|
日期(年-月-日) | 100 |
时间(年-月-日 时:分:秒) | 150 |
人名(兼容 cplm小助手) | 85 |
申请研发组织 | 160 |
### 2. 弹窗
- 内容高度无需 scroll 的,使用弹窗,否则使用抽屉;
- 优先使用 MoveableModal 的可移动弹窗;
- 一次完整功能使用的弹窗深度不得超过三次,否则使用「抽屉+弹窗」或优化需求方案;
- 最小宽度不得超过1000px;
- 弹窗内使用 Table 必须加高度;
- 使用 afterClose 来 onClose 保证弹窗关闭的动画效果;
### 3. 抽屉
- 内容高度需要 scroll 的,使用抽屉;
- 设计对象创建、编辑的交互,必须使用抽屉或页面;
作者:朱黔杨 创建时间:2023-04-19 14:25
最后编辑:陈思奇 更新时间:2023-11-21 15:32
最后编辑:陈思奇 更新时间:2023-11-21 15:32