PHP 代码规范、流程规范、git规范

1. 命名规范

---

 

(1).变量命名规范

1.变量使用驼峰命名法 禁止使用拼音或者拼音加数字 2.变量也应具备描述性，杜绝一切拼音、或拼音英文混杂的命名方式 3.变量包数字、字母和下划线字符，不容许使用其余字符，变量命名最好使用项目 中有据可查的英文缩写方式， 尽能够要使用一目了然容易理解的形式； 4.变量以字母开头，若是变量包多个单词，首字母小写，当包多个单词时，后面 的每一个单词的首字母大写.

例如 ：$itSports

5.变量使用有效命名

例如评论：$commentArr

6.变量属性标记清楚

例如 数组变量后加Arr ：$commentArr,数值： $commentInt

7.变量除了在循环体(for，foreach，while)中，其余位置容许但不鼓励使用没有描述意义的字母做为变量名。

例如：$i,$j。

(2).常量命名规范

1.常量名应具备描述性，杜绝一切拼音、或拼音英文混杂的命名方式 2.常量名包字母字符和下划线，不容许使用数字和其余字符。 3.PHP 的内建值 TRUE、FALSE 和 NULL 必须所有采用大写字母书写。 4.常量名全部字母必须大写，少数特必要的状况下，可以使用划线来分隔单词。

例如： define(‘AAA_BBB_CCC’, ‘true’); (若是常量名由 aaa, bbb, ccc 三个单词组成 的)

define('NAME','root')

(3).类名命名规范

1.一个文件中声明一个类，文件名中必须包类名字符串，这些不只容易查找，也有 利于实如今程序中自动加载类。 2.类名应有描述性，杜绝一切拼音、或拼音英文混杂的命名方式 3.类名包括字母字符，不容许使用数字和其余字符 4.若是类名包括多个单词，应使用驼峰式命名方式，每一个单词的第一个字母必须大写， 不容许连续大写。

类 首字母大写 如 ： class Comment{}

AaaBbbCcc (若是类名由 aaa, bbb, ccc 三个单词组成的)

(4).方法命名规范

1.函数名应具备描述性，杜绝一切拼音、或拼音英文混杂的命名方式 2.函数名包括字母字符，不容许使用数字和其余字符。 3.函数名首字母小写，当包多个单词时，后面的每一个单词的首字母大写.

例如: aaaBbbCcc (若是函数名由 aaa, bbb, ccc 三个单词组成的)

4.函数名应带有get，set等动做性描述。

function getUser(){ //函数内容 } 方法，函数有效命名 ：function getCommentIdByTableName(){}

5.能够声明像函数名前带有下划线的形式，表示该函数为该类的私有方法，外部不容许进行访问。

例如：function _func(){}

 

2. 代码注释

 

 

---

 

1.注释格式

/**

模块-大功能-功能点或方法做用

* @author 做者<邮箱>

* @create 建立时间

* @param $name

* @return array

*/

注释必须按照规范注释

2 . 行注释

// 1.行注释前标清 一、二、3...

//2.简短说明该行代码的做用。

---

 

 

3. 需求明确

 

---

 

1.逻辑清晰

2.目标明确

---

 

 

4.代码语句规范

 

---

 

2.保存数据规范

1.初始化默认属性 2.load加载属性 save保存或修改 3.逻辑问题 必须在beforeSave中处理

---

5.代码提交规范

 

---

 

1.新建工做流（代码必须在工做流上面修改） 2.提交时 先提交代码，在切换到dev , 拉取dev 而后进入工做流合并到工做流 3.进入dev,将工做流合并到dev 4.推送到测试环境 5.代码提交格式 【本身的如今的职务】系统功能 - 大功能 - 详细功能 例如 ： [开发]云系统 - 前台首页 - 编辑轮播图

详细步骤 1. 打开本身sourceTree，在dev拉取最新代码

     2. 点击顶部菜单 “Git工做流”->建立新功能->建立到以本身姓名名称命名的文件夹内便于区分,功能名称是本身作的功能的名称

     3.建立完成，好比是feature/lihuien/首页轮播图管理

     4.代码完成后，首先点击顶部菜单 “提交”->而后切换分支到dev->dev拉取最新代码->在切换到工做流

     5.单击dev,而后右键，会出现“合并dev至当前分支”->点击

     6.而后切换到dev->单击工做流右键 ->出现“合并工做流feature/lihuien/首页轮播图管理代码至当前分支”，点击肯定

     7.最后点击顶部菜单“推送”->选择dev->肯定->切换到本身工做流或者在建立新的工做流进行下一个功能开发

    提示：若是提交出现冲突，请找冲突文件中相应的开发一块儿及时解决，不得擅自解决，以防会往代码库传入垃圾代码或者破坏队友的功能完整性

---

 

 

6.Teambition任务卡片规范

 

---

 

1.本身天天的任务，若是完成就及时点掉 2.若是任务延期 标清延期缘由 3.若是须要别人合做 就添加任务关联 4.本身天天上班必须填写本身任务卡片 5.若是任务须要挂起 写清楚挂起缘由 6.写清楚备注，填写子任务，若是有须要就添加图片描述 任务具体格式： 【本身的如今的职务】系统功能 - 大功能 - 详细功能 [开发]云系统 - 后台 - 员工列表 备注：1.修改员工信息 2.列表搜索等... 子任务1 【开发】员工列表 - 删除员工 - js返回提示 等

---

7.提示返回值

 

---

 

1.true时返回格式 `return json_encode(['status'=>'success','message'='提示信息','data'=>'需求数据'])` 2.false时返回格式 `return json_encode(['status'=>'error','message'='提示信息','data'=>'修改失败（或者错误信息）'])`

---

二.云运动环境规范

 

---

 

1.安装软件

2.服务器 ： xampp 须要安装 3.数据库 ： mysql 5.7版本 须要安装 4.版本控制 ： Git 须要安装 5.git客户端 ： sourceTree 须要安装 6.编辑器 ： phpStorm 须要安装带注册码 7.包管理工具 ： composer 须要安装 8.浏览器 ： chrome 须要安装

2.开发使用环境

1.编辑器 ： phpStorm 2.服务器 ： xampp (php7.0版本) 3.数据库 ： mysql 5.7版本 4.代码仓库 ： coding 5.版本控制 ： Git 6.git客户端 ： sourceTree 7.包管理工具 ： composer 8.浏览器 ： chrome

3.团队工具

1.聊天工具 ： bearyChat 2.任务工具 ： teambition 3.代码托管 ： coding/gitlab

4.需求帐号

1.腾讯企业邮箱帐号 2.coding帐号 3.gitHub帐号 4.bearyChat帐号 5.teambition帐号

5.需求，原型，开发

1.若是在了解需求或原型时 遇到不懂或逻辑不通的需求 请及时跟对应的原型进行沟通，保持开发和原一致性 2.若是遇到问题不能及时解决 请及时跟对应的开发人员沟通

6.sourceTree 规范

1.Master

1.Master分支为线上环境分支 2.该分支只能管理员提交或合并 3.除管理员，禁止开发人员私自操做Master 4.永远不要将代码直接提交到该分支

2. Dev

1.Dev分支为系统测试分支 2.提交到Dev分支必定是完成的完整功能模块 3.代码须要本身测试经过及管理员审核后再提交 4.切记不能提交半成品或者垃圾代码 5.切记不能直接在Dev分支上面修改代码，不然视为无效代码 6.须要开发本身的任务功能时，建立本身的feature工做流

3. Feature

1.Feature分支为我的的开发分支 2.该分支为任务、功能、修改bug的分支 3.分支命名必须规范 如：feature/lihuien/公共分页类 4.上班第一件事就是拉取Dev代码合并到本身的工做流，预防代码合并冲突

 注意：(1).代码未完成千万不能直接提交到Dev、提交代码必定按照规范

    (2).每隔一个小时必须更新一次代码，若是有未提交而且本身功能未开发完整，切记必定要推到本身远程功能分支上

7.数据迁移

1.数据迁移必定要按照规范来写 2.数据属性必定要问明白，在增长 3.迁移必定要写回滚文件 4.迁移后必定要测试无误后在提交到Dev

注意：必定要迁移及回滚测试无误后在提交代码到代码库，不然从新写

8.Yii中Form表单

1.Form 表单验证时 定义的属性 若是重复请使用常量定义后，使用常量，避免重复使用