nocobase/命名规范.md

命名规范

一、数据源

1. 数据表标识：沿用样例数据表（users/roles）格式，采用英文复数形式；涉及多个单词时，全部小写且单词间用下划线（_）分隔，规则为 “除最后一个单词外，其余单词用单数，最后一个单词用复数”。
2. 数据表字段名：采用驼峰命名法（示例：aaaBbbCcc）,且单数。
3. 关系字段：名称和标识与目标数据表保持一致，标识格式为驼峰形式。
4. 选项值（下拉菜单 / 单选 / 复选）：必须使用英文，禁止使用中文；格式为小写且单词间用下划线（_）分隔。
5. 日期时间类型：统一使用不含时区的类型。
6. 日期时间显示：勾选显示时间，若有特殊展示要求，可在页面层进行微调。

二、文件管理器

1. 标题格式：文件管理器类型（如，S3-minio/S3-aws/OSS/COS） - 数据表标识（数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则，单词间用连字符（-）分隔） - 数据表字段名（数据表字段名小写，单词间用连字符（-）分隔）。
2. 存储空间标识格式：数据表标识（数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则，单词间用下划线（_）分隔） _ 数据表字段名（数据表字段名小写，单词间用下划线（_）分隔）。
3. 路径格式：数据表标识（数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则，单词间用连字符（-）分隔）/ 数据表字段名（数据表字段名小写，单词间用连字符（-）分隔）。
4. 文件大小限制：无特殊要求时，统一限制为1GB。
5. 必须要指定文件类型（MIME 格式），否则无法限定文件格式，且与数据表附件字段的MIME 类型保持一致，因为数据表附件字段的MIME 类型为前端表单验证。