隨著項目越來越復雜,項目不僅僅是代碼的集合.文檔與注釋成了項目不可或缺的部分
這邊文檔將說明如何寫出標準的的php注釋
和其他語言一樣,php代碼注釋有行注釋和塊注釋兩類

行注釋 //

是對某一行代碼功能加以說明

示例:

行注釋示例

塊注釋 /* */

塊注釋一般使用在對文件頭部,類,函數(shù),對他們功能加以說明

/**
* @name 名字
* @abstract 申明變量/類/方法
* @access 指明這個變量、類、函數(shù)/方法的存取權限
* @author 函數(shù)作者的名字和郵箱地址

* @category 組織packages
* @copyright 指明版權信息
* @const 指明常量
* @deprecate 指明不推薦或者是廢棄的信息
* @example 示例
* @exclude 指明當前的注釋將不進行分析，不出現(xiàn)在文擋中
* @final 指明這是一個最終的類、方法、屬性，禁止派生、修改。
* @global 指明在此函數(shù)中引用的全局變量
* @include 指明包含的文件的信息
* @link 定義在線連接
* @module 定義歸屬的模塊信息
* @modulegroup 定義歸屬的模塊組
* @package 定義歸屬的包的信息
* @param 定義函數(shù)或者方法的參數(shù)信息
* @return 定義函數(shù)或者方法的返回信息
* @see 定義需要參考的函數(shù)、變量，并加入相應的超級連接。
* @since 指明該api函數(shù)或者方法是從哪個版本開始引入的
* @static 指明變量、類、函數(shù)是靜態(tài)的。
* @throws 指明此函數(shù)可能拋出的錯誤異常,極其發(fā)生的情況
* @todo 指明應該改進或沒有實現(xiàn)的地方
* @var 定義說明變量/屬性。
* @version 定義版本信息
*/

文件頭部注釋

示例:

文件頭部注釋

函數(shù)頭部注釋

示例:

函數(shù)頭部文件注釋

類頭部注釋

示例:

類頭部注釋示例