PHP註解語法規範與命名規範小結分享

本文我們將和大家分享PHP註解語法規範與命名規範，我們知道註解在寫程式碼的過程中非常重要，好的註解能讓你的程式碼讀起來更輕鬆，在寫程式碼的時候一定要注意註釋的規範。希望本文能幫助大家。

HP註解規格

註解在寫程式碼的過程中非常重要，好的註解能讓你的程式碼讀起來更輕鬆，在寫程式碼的時候一定要注意註釋的規範。

「php是一門及其容易入門的語言，剛入門的新手不到幾分鐘的時間可能就會用echo打印出一個hello world ！但是他是真正的程式設計師嗎？怎麼來定義程式設計師呢？一段時間自己也不認識自己寫的了，那該怎麼辦呢？最好的方法當然是給自己的程式碼加上註解。

我們可能熟悉很多註解的寫法C pear PHP註解等等，但我們用到的主要還是# 和/**/。

#是一種簡短的註解方法。可能你會用它去註解一個變量，或是呼叫的一個方法。 /**/我們可能還在用它去註解掉一大段程式碼，但是怎麼用它去標準的註解一個函數呢？

/**

* @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 定義版本資訊
*/

註解的資訊很全面，可能有很多我們用不到，紅色部分是我們常用的。

範例：php裡面常見的幾種註解方式：

1.文件的註釋，介紹檔名，功能以及作者版本號等資訊

/**
* 文件名简单介绍
* 
* 文件功能
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

檔案頭模板

/** 
*这是一个什么文件 
* 
*此文件程序用来做什么的（详细说明，可选。）。 
* @author   richard<e421083458@163.com> 
* @version   $Id$ 
* @since    1.0 
*/

2.類別的註釋，類別名稱及介紹

/**
* 类的介绍
* 
* 类的详细介绍（可选）
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

/** 
* 类的介绍 
* 
* 类的详细介绍（可选。）。 
* @author     richard<e421083458@163.com> 
* @since     1.0 
*/ 
class Test  
{ 
}

3.函數的註釋，函數的作用，參數介紹以及返回類型

/**
* 函数的含义说明
* 
* @access public 
* @author 作者
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明
* @return array 返回类型
* @date 2020-02-02
*/

函數頭部註釋

/** 
* some_func 
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @since 1.0 
* @return array 
*/ 
public function thisIsFunction($string, $integer, $mixed) {return array();}

程式碼註解

1. 註解的原則是將問題解釋清楚，並不是越多越好。

2. 若幹語句作為一個邏輯程式碼區塊，這個區塊的註解可以使用/* */方式。

3. 具體到某一個語句的註釋，可以使用行尾註解：//。

/* 生成配置文件、数据文件。*/ 
 
$this->setConfig(); 
$this->createConfigFile(); //创建配置文件 
$this->clearCache();     // 清除缓存文件 
$this->createDataFiles();  // 生成数据文件 
$this->prepareProxys(); 
$this->restart();

PHP命名規格

#1.目錄與檔案

目錄使用小寫+底線

類別庫，函數檔案統一以.php為後綴

類別的檔案名稱皆以命名空間定義，並且命名空間的路徑和類別庫檔案所在路徑一致
類別檔案採用駝峰法命名（首字母大寫） ，其他檔案採用小寫+底線命名
類別名稱和類別檔案名稱保持一致，統一採用駝峰法（首字母大寫）

2.函數和類，屬性命名

類別的命名採用駝峰法（首字母大寫），例如User、UserType，預設不需要添加後綴，例如UserController應該直接命名為User

函數的命名使用小寫字母和下劃線（小寫字母開頭）的方式，例如get_client_ip

方法的命名使用駝峰法（首字母小寫），例如getUserName(如果方法有回傳值，那麼目前習慣上將首字母用小寫的屬性類型，如s(string)，i(int)，f(float )，b(boolean)，a(array)等)
屬性的命名使用駝峰法（首字母小寫），例如tableName、instance（目前習慣上將首字母用小寫的屬性類型，如s(string) ，i(int)，f(float)，b(boolean)，a(array)等）
以雙下劃線「__」打頭的函數或方法作為魔法方法，例如__call 和__autoload

3.常數與配置

常數以大寫字母和底線命名，例如APP_PATH和THINK_PATH
配置參數以小寫字母和底線命名，例如url_route_on 和url_convert

#4.資料錶盒欄位

資料資料表格和欄位採用小寫加底線方式命名，並注意字段名稱不要以下劃線開頭，例如think_user 表和user_name字段，不建議使用駝峰和中文作為資料表字段命名。

相關推薦：

php如何去除網頁檔案中所有的註解

JavaScript中書寫方式以及註解的詳細介紹

html、css和js註解的規範用法

#

以上是PHP註解語法規範與命名規範小結分享的詳細內容。更多資訊請關注PHP中文網其他相關文章！