/**
* @name 名字
* @abstract 申明變量/類/方法
* @access 指明這個變量、類、函數(shù)/方法的存取權(quán)限
* @author 函數(shù)作者的名字和郵箱地址
* @category 組織packages
* @copyright 指明版權(quán)信息
* @const 指明常量
* @deprecate 指明不推薦或者是廢棄的信息
* @example 示例
* @exclude 指明當(dāng)前的注釋將不進(jìn)行分析，不出現(xiàn)在文擋中
* @final 指明這是一個最終的類、方法、屬性，禁止派生、修改。
* @global 指明在此函數(shù)中引用的全局變量
* @include 指明包含的文件的信息
* @link 定義在線連接
* @module 定義歸屬的模塊信息
* @modulegroup 定義歸屬的模塊組
* @package 定義歸屬的包的信息
* @param 定義函數(shù)或者方法的參數(shù)信息
* @return 定義函數(shù)或者方法的返回信息
* @see 定義需要參考的函數(shù)、變量，并加入相應(yīng)的超級連接。
* @since 指明該api函數(shù)或者方法是從哪個版本開始引入的
* @static 指明變量、類、函數(shù)是靜態(tài)的。
* @throws 指明此函數(shù)可能拋出的錯誤異常,極其發(fā)生的情況
* @todo 指明應(yīng)該改進(jìn)或沒有實現(xiàn)的地方
* @var 定義說明變量/屬性。
* @version 定義版本信息
*/
php里面常見的幾種注釋方式：
1.文件的注釋，介紹文件名，功能以及作者版本號等信息
- 規(guī)范
/**
* 文件名介紹
*
* 文件功用
* @author 作者
* @version 版本號
* @date 2020-02-02
*/
- 示例
/**
* 文件名介紹
*
* 此文件是用來做什么的（可選）
* @author richard<e421083458@163.com>
* @version $Id$
* @since 1.0
*/
2.類的正文，類名及引見
- 規(guī)范
/**
* 類的引見
*
* 類的詳細(xì)引見（可選）
* @author 作者
* @version 版本號
* @date 2020-02-02
*/
- 示例
/**
* 類的引見
*
* 類的詳細(xì)引見（可選）
* @author richard<e421083458@163.com>
* @since 1.0
*/
class Test
{
}
3.函數(shù)的正文，函數(shù)的作用，參數(shù)引見和前往類型
- 規(guī)范
/**
* 函數(shù)的寄義闡明
*
* @access public
* @author 作者
* @param mixed $arg1 參數(shù)1的闡明
* @param mixed $arg2 參數(shù)2的闡明
* @return array 前往類型
* @date 2020-02-02
*/
- 示例
/**
* some_func
* 函數(shù)的寄義闡明
*
* @access public
* @param mixed $arg1 參數(shù)1的闡明
* @param mixed $arg2 參數(shù)2的闡明
* @param mixed $mixed 這是1個混淆類型
* @since 1.0
* @return array
*/
public function thisIsFunction($string, $integer, $mixed)
{
return array();
}
順序代碼正文
注釋的原則是將問題解釋清楚，并不是越多越好。
若干語句作為一個邏輯代碼塊，這個塊的注釋可以使用
/* */方式。具體到某一個語句的注釋，可以使用行尾注釋
//。
/* 生成設(shè)置文件、數(shù)據(jù)文件。*/
$this->setConfig();
$this->createConfigFile(); //創(chuàng)立設(shè)置文件
$this->clearCache(); // 肅清緩存文件
$this->createDataFiles(); // 生成數(shù)據(jù)文件
$this->prepareProxys();
$this->restart();
PHP命名標(biāo)準(zhǔn)
1.目錄和文件
目錄運(yùn)用小寫+下劃線
類庫，函數(shù)文件一致以.php為后綴
類的文件名均以命名空間界說，而且命名空間的途徑和類庫文件所在途徑分歧
類文件采取駝峰法命名（首字母大寫），其他文件采取小寫+下劃線命名
類名和類文件名堅持分歧，一致采取駝峰法（首字母大寫）
2.函數(shù)和類，屬性命名
類的命名采取駝峰法（首字母大寫），例如 User、UserType，默許不需求添加后綴，例如UserController應(yīng)當(dāng)直接命名為User
函數(shù)的命名運(yùn)用小寫字母和下劃線（小寫字母掃尾）的方式，例如 get_client_ip
辦法的命名運(yùn)用駝峰法（首字母小寫），例如 getUserName(假如辦法有前往值，那末現(xiàn)在習(xí)氣上將首字母用小寫的屬性類型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等)
屬性的命名運(yùn)用駝峰法（首字母小寫），例如 tableName、instance（現(xiàn)在習(xí)氣上將首字母用小寫的屬性類型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等）
以雙下劃線“__”打頭的函數(shù)或辦法作為邪術(shù)辦法，例如 __call 和 __autoload
3.常量和設(shè)置
常量以大寫字母和下劃線命名，例如 APP_PATH和 THINK_PATH
設(shè)置參數(shù)以小寫字母和下劃線命名，例如 url_route_on 和url_convert
4.數(shù)據(jù)表盒字段
數(shù)據(jù)表和字段采取小寫加下劃線方式命名，并留意字段名不要以下劃線掃尾，例如 think_user 表和 user_name字段，不建議運(yùn)用駝峰和中文作為數(shù)據(jù)表字段命名。
