forked from duguangtech/nocobase
2.7 KiB
2.7 KiB
命名规范
一、数据源
- 数据表标识:沿用样例数据表(users/roles)格式,采用英文复数形式;涉及多个单词时,全部
小写且单词间用下划线(_)分隔,规则为 “除最后一个单词外,其余单词用单数,最后一个单词用复数”。 - 数据表字段标识:采用驼峰命名法(示例:aaaBbbCcc),且
单数。 - 关系字段:
名称和标识与目标数据表保持一致,标识格式为驼峰形式。 - 选项值(下拉菜单 / 单选 / 复选):必须使用英文,禁止使用中文;格式为
小写且单词间用下划线(_)分隔。 - 日期时间类型:统一使用不含时区的类型。
- 日期时间显示:勾选
显示时间,若有特殊展示要求,可在页面层进行微调。 - 多对多关系表:名称为
A表名称与B表名称映射、标识为A表标识_B表标识_mappings,预置字段只保留创建日期与最后修改日期。
A表:a_table
B表:b_table
多对多关系表:
名称:A表与B表映射
标识:a_table_b_table_mappings
二、文件管理器
- 标题格式:
文件管理器类型(如,服务端上传:S3/OSS/COS,客户端上传:S3)-数据表标识(数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则,单词间用连字符(-)分隔)-数据表字段名(数据表字段名小写,单词间用连字符(-)分隔)。 - 存储空间标识格式:
数据表标识(数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则,单词间用下划线(_)分隔)_数据表字段名(数据表字段名小写,单词间用下划线(_)分隔)。 - 路径格式:
数据表标识(数据表字段名遵循 “除最后一个单词外其余用单数、最后一个单词用复数” 规则,单词间用连字符(-)分隔)/数据表字段名(数据表字段名小写,单词间用连字符(-)分隔)。 - 重命名:v2版本开始,无特殊要求时,选
随机字符串。 - 文件大小限制:无特殊要求时,统一限制为
1GB。 - 必须要指定
文件类型(MIME 格式),否则无法限定文件格式,且与数据表附件字段的MIME 类型保持一致,因为数据表附件字段的MIME 类型为前端表单验证。
三、变量和密钥
- 名称格式:
大写且单词间用下划线(_)
四、页面
- 没有特殊要求时,所有的
列表/卡片等数据按最后修改日期降序排序
五、工作流
- 子工作的
标题命名以「子工作流」为前缀