註解在寫程式碼的過程中非常重要，好的註解能讓你的程式碼讀起來更輕鬆，在寫程式碼的時候一定要注意註解的規範,這裡腳本之家小編就為大家整理一下，需要的朋友可以參考下。
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字段，不建議使用駝峰和中文作為資料表欄位命名。
