| 標示 | 作用 | | --- | --- | | access | 該標記用于指明關鍵字的存取全權限。 可以是：private，public，proteced。 使用范圍：class，function，var，define，module。 | | author | 指明作者。 | | copyright | 指明版權信息。 | | const | 指明PHP中的define的常量。 使用范圍：define。 | | final | 指明關鍵字是一個最終的類、方法、屬性，禁止派生，修改。 使用范圍：class，function，var。 | | global | 指明在此函數中引用的全局變量。 | | name | 為關鍵字指明一個別名。 | | package | 用于邏輯上將一個或幾個關鍵字分到一組。 | | abstract | 說明當前累是一個抽象類。 | | param | 指明一個函數的參數。 | | return | 指明一個函數的返回值。 | | static | 指明關鍵字是靜態的。 | | var | 指明變量類型。 | | version | 指明版本信息。 | | todo | 指明應該改進或者沒有實現的地方。 | | link | 可以通過link指到文檔中的任何一個關鍵字。 | | ignore | 用于在文檔中忽略制定的關鍵字。 | >[info]PHP注釋有三種語法： ~~~php // 這樣事單行注釋 # 這樣也是單行注釋，但是很多教程里并沒有說這種方式 /* * 這樣是多行注釋 */ ~~~ ~~~ /** * XXXXX的文件 * * 功能1： xxx * 功能2： xxx * * @file * @package core * @author Joy <author@yunzhongkan.com> * @version $Id: php開發注釋規范.txt,v 1.1 2014/03/04 20:37:46 Joy Exp $ * @link http://www.yunzhongkan.com */ ~~~ ~~~ /** * Class 類名 * @package 命名空間 * 等等 */ ~~~ ~~~ /** * 函數的含義說明 * * @access public * @param mixed $arg1 參數一的說明 * @param mixed $arg2 參數二的說明 * @param mixed $mixed 這是一個混合類型 * @return array 返回類型 */ ~~~