總結(jié)PHP代碼規(guī)范、流程規(guī)范、git規(guī)范

代碼規(guī)范、git規(guī)范、teambition規(guī)范、yii規(guī)范

1. 命名規(guī)范

(1).變量命名規(guī)范

1.變量使用駝峰命名法 禁止使用拼音或者拼音加數(shù)字

2.變量也應(yīng)具有描述性，杜絕一切拼音、或拼音英文混雜的命名方式

3.變量包數(shù)字、字母和下劃線字符，不允許使用其他字符，變量命名最好使用項(xiàng)目 中有據(jù)可查的英文縮寫方式， 盡可以要使用一目了然容易理解的形式；

4.變量以字母開頭，如果變量包多個單詞，首字母小寫，當(dāng)包多個單詞時，后面 的每個單詞的首字母大寫.例如 ：$itSports

5.變量使用有效命名

例如評論：$commentArr

6.變量屬性標(biāo)記清楚

例如 數(shù)組變量后加Arr ：$commentArr,數(shù)值： $commentInt

7.變量除了在循環(huán)體(for，foreach，while)中，其他位置允許但不鼓勵使用沒有描述意義的字母作為變量名。

例如：$i,$j。

(2).常量命名規(guī)范

1.常量名應(yīng)具有描述性，杜絕一切拼音、或拼音英文混雜的命名方式

2.常量名包字母字符和下劃線，不允許使用數(shù)字和其他字符。

3.PHP 的內(nèi)建值 TRUE、FALSE 和 NULL 必須全部采用大寫字母書寫。

4.常量名所有字母必須大寫，少數(shù)特必要的情況下，可使用劃線來分隔單詞。

例如： define(‘AAA_BBB_CCC', ‘true'); (如果常量名由 aaa, bbb, ccc 三個單詞組成 的)

define('NAME','root')

(3).類名命名規(guī)范

1.一個文件中聲明一個類，文件名中必須包類名字符串，這些不僅容易查找，也有 利于實(shí)現(xiàn)在程序中自動加載類。
2.類名應(yīng)有描述性，杜絕一切拼音、或拼音英文混雜的命名方式
3.類名包括字母字符，不允許使用數(shù)字和其他字符
4.如果類名包括多個單詞，應(yīng)使用駝峰式命名方式，每個單詞的第一個字母必須大寫， 不允許連續(xù)大寫。
類 首字母大寫 如 ： class Comment{}

AaaBbbCcc (如果類名由 aaa, bbb, ccc 三個單詞組成的)

(4).方法命名規(guī)范

1.函數(shù)名應(yīng)具有描述性，杜絕一切拼音、或拼音英文混雜的命名方式
2.函數(shù)名包括字母字符，不允許使用數(shù)字和其他字符。
3.函數(shù)名首字母小寫，當(dāng)包多個單詞時，后面的每個單詞的首字母大寫.
例如: aaaBbbCcc (如果函數(shù)名由 aaa, bbb, ccc 三個單詞組成的)

4.函數(shù)名應(yīng)帶有g(shù)et，set等動作性描述。

function getUser(){ //函數(shù)內(nèi)容 } 方法，函數(shù)有效命名 ：function getCommentIdByTableName(){}

5.可以聲明像函數(shù)名前帶有下劃線的形式，表示該函數(shù)為該類的私有方法，外部不允許進(jìn)行訪問。

例如：function _func(){}

2. 代碼注釋

1.注釋格式

/**

模塊-大功能-功能點(diǎn)或方法作用

* @author 作者郵箱>

* @create 創(chuàng)建時間

* @param $name

* @return array

*/

注釋必須按照規(guī)范注釋

2 . 行注釋

// 1.行注釋前標(biāo)清 1、2、3...

//2.簡短說明該行代碼的作用。

3. 需求明確

1.邏輯清晰

2.目標(biāo)明確

4.代碼語句規(guī)范

2.保存數(shù)據(jù)規(guī)范

1.初始化默認(rèn)屬性

2.load加載屬性 save保存或修改

3.邏輯問題 必須在beforeSave中處理

5.代碼提交規(guī)范

1.新建工作流（代碼必須在工作流上面修改）

2.提交時 先提交代碼，在切換到dev , 拉取dev 然后進(jìn)入工作流合并到工作流

3.進(jìn)入dev,將工作流合并到dev

4.推送到測試環(huán)境

5.代碼提交格式

【自己的現(xiàn)在的職務(wù)】系統(tǒng)功能 - 大功能 - 詳細(xì)功能

例如 ： [開發(fā)]云系統(tǒng) - 前臺首頁 - 編輯輪播圖
詳細(xì)步驟

1. 打開自己sourceTree，在dev拉取最新代碼

2. 點(diǎn)擊頂部菜單 “Git工作流”->創(chuàng)建新功能->創(chuàng)建到以自己姓名名稱命名的文件夾內(nèi)便于區(qū)分,功能名稱是自己做的功能的名稱

3.創(chuàng)建完成，比如是feature/lihuien/首頁輪播圖管理

4.代碼完成后，首先點(diǎn)擊頂部菜單 “提交”->然后切換分支到dev->dev拉取最新代碼->在切換到工作流

5.單擊dev,然后右鍵，會出現(xiàn)“合并dev至當(dāng)前分支”->點(diǎn)擊

6.然后切換到dev->單擊工作流右鍵 ->出現(xiàn)“合并工作流feature/lihuien/首頁輪播圖管理代碼至當(dāng)前分支”，點(diǎn)擊確定

7.最后點(diǎn)擊頂部菜單“推送”->選擇dev->確定->切換到自己工作流或者在創(chuàng)建新的工作流進(jìn)行下一個功能開發(fā)

提示：如果提交出現(xiàn)沖突，請找沖突文件中相應(yīng)的開發(fā)一起及時解決，不得擅自解決，以防會往代碼庫傳入垃圾代碼或者破壞隊(duì)友的功能完整性

6.Teambition任務(wù)卡片規(guī)范

1.自己每天的任務(wù)，如果完成就及時點(diǎn)掉

2.如果任務(wù)延期 標(biāo)清延期原因

3.如果需要別人合作 就添加任務(wù)關(guān)聯(lián)

4.自己每天上班必須填寫自己任務(wù)卡片

5.如果任務(wù)需要掛起 寫清楚掛起原因

6.寫清楚備注，填寫子任務(wù)，如果有需要就添加圖片描述

任務(wù)具體格式：

【自己的現(xiàn)在的職務(wù)】系統(tǒng)功能 - 大功能 - 詳細(xì)功能

[開發(fā)]云系統(tǒng) - 后臺 - 員工列表

備注：

1.修改員工信息

2.列表搜索等...

子任務(wù)1 【開發(fā)】員工列表 - 刪除員工 - js返回提示
等

7.提示返回值

1.true時返回格式

`return json_encode(['status'=>'success','message'='提示信息','data'=>'需求數(shù)據(jù)'])`

2.false時返回格式

`return json_encode(['status'=>'error','message'='提示信息','data'=>'修改失?。ɑ蛘咤e誤信息）'])`

二.云運(yùn)動環(huán)境規(guī)范

1.安裝軟件

2.服務(wù)器 ： xampp 需要安裝

3.數(shù)據(jù)庫 ： mysql 5.7版本 需要安裝

4.版本控制 ： Git 需要安裝

5.git客戶端 ： sourceTree 需要安裝

6.編輯器 ： phpStorm 需要安裝帶注冊碼

7.包管理工具 ： composer 需要安裝

8.瀏覽器 ： chrome 需要安裝

2.開發(fā)使用環(huán)境

1.編輯器 ： phpStorm

2.服務(wù)器 ： xampp (php7.0版本)

3.數(shù)據(jù)庫 ： mysql 5.7版本

4.代碼倉庫 ： coding

5.版本控制 ： Git

6.git客戶端 ： sourceTree

7.包管理工具 ： composer

8.瀏覽器 ： chrome

3.團(tuán)隊(duì)工具

1.聊天工具 ： bearyChat

2.任務(wù)工具 ： teambition

3.代碼托管 ： coding/gitlab

4.需求賬號

1.騰訊企業(yè)郵箱賬號

2.coding賬號

3.gitHub賬號

4.bearyChat賬號

5.teambition賬號

5.需求，原型，開發(fā)

1.如果在了解需求或原型時 遇到不懂或邏輯不通的需求 請及時跟對應(yīng)的原型進(jìn)行溝通，保持開發(fā)和原一致性

2.如果遇到問題不能及時解決 請及時跟對應(yīng)的開發(fā)人員溝通

6.sourceTree 規(guī)范

1.Master

1.Master分支為線上環(huán)境分支
2.該分支只能管理員提交或合并
3.除管理員，禁止開發(fā)人員私自操作Master
4.永遠(yuǎn)不要將代碼直接提交到該分支

2. Dev

1.Dev分支為系統(tǒng)測試分支
2.提交到Dev分支一定是完成的完整功能模塊
3.代碼需要自己測試通過及管理員審核后再提交
4.切記不能提交半成品或者垃圾代碼
5.切記不能直接在Dev分支上面修改代碼，否則視為無效代碼
6.需要開發(fā)自己的任務(wù)功能時，創(chuàng)建自己的feature工作流

3. Feature

1.Feature分支為個人的開發(fā)分支
2.該分支為任務(wù)、功能、修改bug的分支
3.分支命名必須規(guī)范 如：feature/lihuien/公共分頁類
4.上班第一件事就是拉取Dev代碼合并到自己的工作流，預(yù)防代碼合并沖突

注意：

(1).代碼未完成千萬不能直接提交到Dev、提交代碼一定按照規(guī)范

(2).每隔一個小時必須更新一次代碼，如果有未提交并且自己功能未開發(fā)完整，切記一定要推到自己遠(yuǎn)程功能分支上

7.數(shù)據(jù)遷移

1.數(shù)據(jù)遷移一定要按照規(guī)范來寫
2.數(shù)據(jù)屬性一定要問明白，在增加
3.遷移一定要寫回滾文件
4.遷移后一定要測試無誤后在提交到Dev
注意：一定要遷移及回滾測試無誤后在提交代碼到代碼庫，否則重新寫

8.Yii中Form表單

1.Form 表單驗(yàn)證時 定義的屬性 如果重復(fù)請使用常量定義后，使用常量，避免重復(fù)使用