好的規範就像人穿的衣服，一個再好看的美女，衣著邋遢不合體，整個人的氣質也會大大降低。
作者/萬能的阿香
本文原發時間：2019-07-14
本文大概閱讀時間2分鐘
速查目錄
- 一、本文的寫作原因
- 二、版本控制規範
- 三、代碼註釋規範
- 四、PhpStorm常用小技巧
一、本文的寫作原因
來新公司快2周啦，負責的項目是用tp3.0寫的，熟悉的過程真的是太痛苦了，沒文檔、註釋少、無版本提交記錄等等(相信大家都碰到過，這裡就不展開了，哈哈 大家都懂的 QAQ )
公司暫時這方面沒有太規範性的東西，為了讓以後接手的小夥伴少痛苦點，決定整點規範性的東西給自己用，服務自己、服務他人，同時也能慢慢的提升一下自己（以下內容部分整理自網絡）
好了下面開始進入正題啦^_^
二、版本控制規範
先來打個樣，我們日常提交版本信息的時候可以像下面這樣寫commit(svn|git) :
feat(人員新增): 增加人員批量導入
- 增加批量報盤功能
- 增加人員報盤後結果查詢功能
- 修改人員新增佈局
複製代碼
乍一看可能還是不清楚提交格式到底什麼樣子，那麼我們接著看
具體的格式內容(用git的同學可以看這個commitizen)
<type>(<scope>):這裡是個空格<subject>
<blank>這是空行不用寫內容
<blank> 這也是空行不用寫內容
<footer>
複製代碼
/<footer>/<blank>/<blank>/<subject>/<scope>/<type>
上面提到的格式字段說明
- type 表示提交類別，具體內容如下(可以根據項目具體定義):
* feat: 添加新特性
* fix: 修復bug
* docs: 僅僅修改了文檔
* style: 僅僅修改了空格、格式縮進、都好等等，不改變代碼邏輯
* refactor: 代碼重構，沒有加新功能或者修復bug
* perf: 優化相關，比如提升性能、體驗
* test: 增加測試用例
* chore: 改變構建流程、或者增加依賴庫、工具等
* revert: 回滾到上一個版本
- scope 表示修改範圍,非必填（建議填寫）
- subject 標題
- body 提交內容主體的具體描述內容
複製代碼
三、代碼註釋規範
自己開發使用的是PhpStorm ，註釋主要是基於PhpStorm的Live Templates模板快速生成的(模板變量速查表地址)
先上圖，看看具體效果,這樣看起來是不是很清爽呢
下面是註釋中比較常用的註釋名，根據自己需要具體選擇
/**
* @name 名字
* @abstract 申明變量/類/方法
* @access 指明這個變量、類、函數/方法的存取權限
* @author 函數作者的名字和郵箱地址
* @category 組織packages
* @copyright 指明版權信息
* @const 指明常量
* @deprecate 指明不推薦或者是廢棄的信息
* @example 示例
* @exclude 指明當前的註釋將不進行分析，不出現在文擋中
* @final 指明這是一個最終的類、方法、屬性，禁止派生、修改。
* @global 指明在此函數中引用的全局變量
* @include 指明包含的文件的信息
* @link 定義在線連接
* @module 定義歸屬的模塊信息
* @modulegroup 定義歸屬的模塊組
* @package 定義歸屬的包的信息
* @param 定義函數或者方法的參數信息
* @return 定義函數或者方法的返回信息
* @see 定義需要參考的函數、變量，並加入相應的超級連接。
* @since 指明該api函數或者方法是從哪個版本開始引入的
* @static 指明變量、類、函數是靜態的。
* @throws 指明此函數可能拋出的錯誤異常,極其發生的情況
* @todo 指明應該改進或沒有實現的地方
* @var 定義說明變量/屬性。
* @version 定義版本信息
*/
複製代碼
四、PhpStorm提升技巧
美之所以如此重要，皆因愛美之心人皆有之。無論對於人，還是對於文，都如此。
附上快速生成註釋的配置方式，還沒配置的小夥伴趕緊試試吧，是不是很貼心，記得打開大圖查看哦
(注：代碼都是用IDE快速生成的哦，相信大家都是很“懶”的，才不會用手敲這麼多呢，多累啊哈哈)
---------------------------------------------華麗的分割線-----------------------------------------------
老夫燎髮少年狂
不小心,選錯行
誤入IT，兩眼淚茫茫
阿香溫馨提示：看完記得休息一下，今天也要元氣滿滿哦
有問題歡迎隨時交流
THE END ^_^
閱讀更多 富平小哥 的文章
