-
Notifications
You must be signed in to change notification settings - Fork 0
文档设计标准
duangsuse edited this page May 31, 2018
·
1 revision
- 应该尽可能符合 GitHub Styled Markdown 语法规范,使用合适的中文文体并合理使用 斜体 粗体
代码块
链接 -
粗体 在强调对象描述时使用、斜体 在引用对象时使用、
代码块
在引用代码时使用、如果有必要,可以给 资源 添加链接 - 不应该有不正确的 缩进、空格、大小写、全半角符号,中文字符(非全角标点)和 数字/英文字符 间必须添加空格
在合适的地方也可以使用 Markdown 引用 添加额外 注意事项
- 数据库字段的英文单词的 单复数 问题: 数据库表 使用 复数,其他 则使用 单数
- 有可能为字段添加所存储数据模式描述的,则添加描述,如:
install_url
、icon_url
、parent_category
- 记录 创建时间 和 更新时间 的字段使用命名
created_at
和updated_at
-
RDBMS 对象引用字段使用 所引用对象单数名称 为名称,如
user
、app
- PostgreSQL 中,非类型声明的关键字 全大写,类型声明使用 PascalCased,标识符 全小写
-
Postgres 中,可能为
Null
的字段在 Rust 中表示为Option<T>
-
PostgreSQL 中,仅 描述数据结构,不要设置除
NOT Null
外的 约束 - 关于排行所用自动生成字段的问题,必须加
_num
- 仔细检查
database migration up/down、rust struct
中字段和表的名称是否对应 - 在数据结构中合理的增加 限制,如 版本名长度 限制