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 表單驗證時 定義的屬性 若是重複請使用常量定義後，使用常量，避免重複使用