前人栽樹後人乘涼，給本身的代碼來點規範-但願對你們有用

時間 2019-12-01

標籤前人栽樹後人乘涼本身代碼規範但願你們有用欄目快樂工作简体版

原文原文鏈接

好的規範就像人穿的衣服，一個再好看的美女，衣着邋遢不合體，整我的的氣質也會大大下降。php

做者/萬能的阿香
本文原發時間：2019-07-14
本文大概閱讀時間2分鐘
git

速查目錄

1、本文的寫做緣由
2、版本控制規範
3、代碼註釋規範
4、PhpStorm經常使用小技巧

1、本文的寫做緣由

來新公司快2周啦，負責的項目是用tp3.0寫的，熟悉的過程真的是太痛苦了，沒文檔、註釋少、無版本提交記錄等等(相信你們都碰到過，這裏就不展開了，哈哈你們都懂的 QAQ )npm

公司暫時這方面沒有太規範性的東西，爲了讓之後接手的小夥伴少痛苦點，決定整點規範性的東西給本身用，服務本身、服務他人，同時也能慢慢的提高一下本身（如下內容部分整理自網絡）api

好了下面開始進入正題啦^_^網絡

2、版本控制規範

先來打個樣，咱們平常提交版本信息的時候能夠像下面這樣寫commit(svn|git) :

feat(人員新增): 增長人員批量導入

- 增長批量報盤功能
- 增長人員報盤後結果查詢功能
- 修改人員新增佈局
複製代碼

乍一看可能仍是不清楚提交格式到底什麼樣子，那麼咱們接着看svn

具體的格式內容(用git的同窗能夠看這個commitizen)

<type>(<scope>):這裏是個空格<subject>
<BLANK LINE>這是空行不用寫內容
<body>
<BLANK LINE> 這也是空行不用寫內容
<footer>
複製代碼

上面提到的格式字段說明

- type 表示提交類別，具體內容以下(能夠根據項目具體定義):
    * feat: 添加新特性
    * fix: 修復bug
    * docs: 僅僅修改了文檔
    * style: 僅僅修改了空格、格式縮進、都好等等，不改變代碼邏輯
    * refactor: 代碼重構，沒有加新功能或者修復bug
    * perf: 優化相關，好比提高性能、體驗
    * test: 增長測試用例
    * chore: 改變構建流程、或者增長依賴庫、工具等
    * revert: 回滾到上一個版本
- scope 表示修改範圍,非必填（建議填寫）
- subject 標題
- body 提交內容主體的具體描述內容
複製代碼

3、代碼註釋規範

本身開發使用的是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 定義版本信息 */

複製代碼