总体
- 尽量用点语法(如 redis 等的 key)
- 考虑单复数(可以自创单词的复数,比如粽子: zongzis)
- 有些用英文不方便表示,直接用拼音,如 zongzi(粽子),允许英文、拼音混合
- 项目名&项目目录:小写+“-”
- 根据项目(框架)风格,与其保持一致即可
PHP 部分
- 变量名:_
- 函数名:小驼峰
- 类名:大驼峰
- 放Class(如控制器、模型)的文件名:大驼峰
- 不放Class(如配置文件、辅助函数)的文件名:小写连拼、小驼峰、小写+下划线
Laravel 部分
对象 | 规则 | 更优的写法 | 应避免的写法 |
---|---|---|---|
控制器 | 单数 | ArticleController | |
路由 | 复数 | articles/1 | |
路由命名 | 带点符号的蛇形命名 | users.show_active | |
模型 | 单数 | User | |
hasOne 或 belongsTo 关系 | 单数 | articleComment | |
所有其他关系 | 复数 | articleComments | |
表单 | 复数 | article_comments | |
透视表 | 按字母顺序排列模型 | article_user | |
数据表字段 | 使用蛇形并且不要带表名 | meta_title | |
模型参数 | 蛇形命名 | $model->created_at | |
外键 | 带有_id 后缀的单数模型名称 | article_id | |
主键 | – | id | |
迁移 | – | 2017_01_01_000000_create_articles_table | |
方法 | 驼峰命名 | getAll | |
资源控制器 | table | store | |
测试类 | 驼峰命名 | testGuestCannotSeeArticle | |
变量 | 驼峰命名 | $articlesWithAuthor | |
集合 | 描述性的,复数的 | $activeUsers = User::active()->get() | |
对象 | 描述性的,单数的 | $activeUser = User::active()->first() | |
配置和语言文件索引 | 蛇形命名 | articles_enabled | |
视图 | 短横线命名 | show-filtered.blade.php | |
配置 | 蛇形命名 | google_calendar.php | |
内容 (interface) | 形容词或名词 | Authenticatable | |
Trait | 使用形容词 | Notifiable |
Mysql 部分
- 小写+下划线
- html 部分 input.name 和数据库字段保持一致
前端部分
展示给用户的
html、blade模板、vue组件等文件名: 小写+“-”