forked from duguangtech/nocobase
21 lines
1.7 KiB
Markdown
21 lines
1.7 KiB
Markdown
# 命名规范
|
||
|
||
## 一、数据源
|
||
|
||
1. 数据表标识：沿用样例数据表（users/roles）格式，采用英文复数形式；涉及多个单词时，全部`小写且单词间用下划线（_）`分隔，规则为
|
||
“除最后一个单词外，其余单词用`单数`，最后一个单词用`复数`”。
|
||
2. 数据表字段名：采用驼峰命名法（示例：aaaBbbCcc）,且`单数`。
|
||
3. 关系字段：`名称`和`标识`与目标数据表保持一致，标识格式为`驼峰`形式。
|
||
4. 选项值（下拉菜单 / 单选 / 复选）：必须使用英文，禁止使用中文；格式为`小写且单词间用下划线（_）`分隔。
|
||
5. 日期时间类型：统一使用不含时区的类型。
|
||
6. 日期时间显示：勾选`显示时间`，若有特殊展示要求，可在页面层进行微调。
|
||
|
||
## 二、文件管理器
|
||
|
||
1. 存储空间标识格式：`文件管理器类型（如，S3_minio/S3_aws/OSS/COS）` _ `数据表标识（数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数”
|
||
规则，单词间用下划线（_）分隔）` _ `数据表字段名（数据表字段名小写，单词间用下划线（_）分隔）`。
|
||
2. 路径格式：`数据表标识（数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则，单词间用连字符（-）分隔）`/
|
||
`数据表字段名（数据表字段名小写，单词间用连字符（-）分隔）`。
|
||
3. 文件大小限制：无特殊要求时，统一限制为`1GB`。
|
||
4. 必须要指定`文件类型（MIME 格式）`，否则无法限定文件格式，且与数据表附件字段的`MIME 类型`保持一致，因为数据表附件字段的`MIME 类型`为前端表单验证。
|