所有的文檔性注釋都是由/**開始的一個多行注釋，在phpDocumentor里稱為DocBlock, DocBlock是指軟件開發(fā)人員編寫的關于某個關鍵字的幫助信息，使得其他人能夠通過它知道這個關鍵字的具體用途，如何使用。 PhpDocumentor規(guī)定一個DocBlock包含如下信息：
1. 功能簡述區(qū)
2. 詳細說明區(qū)
3. 標記tag
文檔性注釋的第一行是功能描述區(qū)，正文一般是簡明扼要地說明這個類，方法或者函數(shù)的功能，功能簡述的正文在生成的文檔中將顯示在索引區(qū)。功能描述區(qū)的內(nèi)容可以通過一個空行或者 . 來結(jié)束
在功能描述區(qū)后是一個空行，接著是詳細說明區(qū),. 這部分主要是詳細說明你的API的功能，用途，如果可能，也可以有用法舉例等等。在這部分，你應該著重闡明你的API函數(shù)或者方法的通常的用途，用法，并且指明是否是跨平臺的（如果涉及到），對于和平臺相關的信息，你要和那些通用的信息區(qū)別對待，通常的做法是另起一行，然后寫出在某個特定平臺上的注意事項或者是特別的信息，這些信息應該足夠，以便你的讀者能夠編寫相應的測試信息，比如邊界條件，參數(shù)范圍，斷點等等。
之后同樣是一個空白行，然后是文檔的標記tag，指明一些技術上的信息，主要是最主要的是調(diào)用參數(shù)類型，返回值極其類型，繼承關系，相關方法/函數(shù)等等。
關于文檔標記，詳細的請參考第四節(jié):文檔標記。
文檔注釋中還可以使用例如<b> <code>這樣的標簽，詳細介紹請參考附錄二。
下面是一個文檔注釋的例子

/**
* 函數(shù)add,實現(xiàn)兩個數(shù)的加法
*
* 一個簡單的加法計算，函數(shù)接受兩個數(shù)a、b，返回他們的和c
*
* @param int 加數(shù)
* @param int 被加數(shù)
* @return integer
*/
function Add($a, $b) {
return $a+$b;
}

生成文檔如下：
Add
integer Add( int $a, int $b)
[line 45]
函數(shù)add,實現(xiàn)兩個數(shù)的加法
Constants 一個簡單的加法計算，函數(shù)接受兩個數(shù)a、b，返回他們的和c
Parameters
? int $a - 加數(shù)
? int $b - 被加數(shù)
5．文檔標記：
文檔標記的使用范圍是指該標記可以用來修飾的關鍵字，或其他文檔標記。
所有的文檔標記都是在每一行的 * 后面以@開頭。如果在一段話的中間出來@的標記，這個標記將會被當做普通內(nèi)容而被忽略掉。
@access
使用范圍：class,function,var,define,module
該標記用于指明關鍵字的存取權(quán)限：private、public或proteced
@author
指明作者
@copyright
使用范圍：class，function，var，defi

使用范圍：define
用來指明php中define的常量
@final
使用范圍：class,function,var
指明關鍵字是一個最終的類、方法、屬性，禁止派生、修改。
@filesource
和example類似，只不過該標記將直接讀取當前解析的php文件的內(nèi)容并顯示。
@global
指明在此函數(shù)中引用的全局變量
@ingore
用于在文檔中忽略指定的關鍵字
@license
相當于html標簽中的<a>,首先是URL，接著是要顯示的內(nèi)容
例如<a href=”http://www.baidu.com”>百度</a>
可以寫作 @license http://www.baidu.com 百度
@link
類似于license
但還可以通過link指到文檔中的任何一個關鍵字
@name
為關鍵字指定一個別名。
@package
使用范圍：頁面級別的-> define，function，include
類級別的->class，var，methods
用于邏輯上將一個或幾個關鍵字分到一組。
@abstrcut
說明當前類是一個抽象類
@param
指明一個函數(shù)的參數(shù)
@return
指明一個方法或函數(shù)的返回指
@static
指明關建字是靜態(tài)的。
@var
指明變量類型
@version
指明版本信息
@todo
指明應該改進或沒有實現(xiàn)的地方
@throws
指明此函數(shù)可能拋出的錯誤異常,極其發(fā)生的情況
上面提到過，普通的文檔標記標記必須在每行的開頭以@標記，除此之外，還有一種標記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函數(shù)或方法的內(nèi)容
6．一些注釋規(guī)范
a.注釋必須是
/**
* XXXXXXX
*/
的形式
b.對于引用了全局變量的函數(shù)，必須使用glboal標記。
c.對于變量，必須用var標記其類型（int,string,bool...）
d.函數(shù)必須通過param和return標記指明其參數(shù)和返回值
e.對于出現(xiàn)兩次或兩次以上的關鍵字，要通過ingore忽略掉多余的，只保留一個即可
f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標記鏈接到相應的部分，便于文檔的閱讀。
g.必要的地方使用非文檔性注釋，提高代碼易讀性。
h.描述性內(nèi)容盡量簡明扼要，盡可能使用短語而非句子。
i.全局變量，靜態(tài)變量和常量必須用相應標記說明
7. 總結(jié)
phpDocumentor是一個非常強大的文檔自動生成工具，利用它可以幫助我們編寫規(guī)范的注釋，生成易于理解，結(jié)構(gòu)清晰的文檔，對我們的代碼升級，維護,移交等都有非常大的幫助。
關于phpDocumentor更為詳細的說明，可以到它的官方網(wǎng)站
http://manual.phpdoc.org/查閱
8．附錄
附錄1:
能夠被phpdoc識別的關鍵字：
Include
Require
include_once
require_once
define
function
global
class
附錄2
文檔中可以使用的標簽
<b>
<code>
<br>
<kdb>
<li>
<pre>
<ul>
<samp>
<var>
附錄三：
一段含有規(guī)范注釋的php代碼 :

<?php
/**
* Sample File 2, phpDocumentor Quickstart
*
* This file demonstrates the rich information that can be included in
* in-code documentation through DocBlocks and tags.
* @author Greg Beaver <cellog@php.net>
* @version 1.0
* @package sample
*/
// sample file #1
/**
* Dummy include value, to demonstrate the parsing power of phpDocumentor
*/
include_once 'sample3.php';
/**
* Special global variable declaration DocBlock
* @global integer $GLOBALS['_myvar']
* @name $_myvar
*/
$GLOBALS['_myvar'] = 6;
/**
* Constants
*/
/**
* first constant
*/
define('testing', 6);
/**
* second constant
*/
define('anotherconstant', strlen('hello'));
/**
* A sample function docblock
* @global string document the fact that this function uses $_myvar
* @staticvar integer $staticvar this is actually what is returned
* @param string $param1 name to declare
* @param string $param2 value of the name
* @return integer
*/
function firstFunc($param1, $param2 = 'optional') {
/**
* A sample private variable, this can be hidden with the --parseprivate
* option
* @accessprivate
* @var integer|string
*/
var $firstvar = 6;
/**
* @link http://www.example.com Example link
* @see myclass()
* @uses testing, anotherconstant
* @var array
*/
var $secondvar =
array(
    'stuff' =>
                 array( 
                                  6, 
                                  17, 
                                  'armadillo' 
                          ), 
    testing => anotherconstant
);
/**
* Constructor sets up {@link $firstvar}
*/
function myclass() {
$this->firstvar = 7;
}
/**
* Return a thingie based on $paramie
* @param boolean $paramie
* @return integer|babyclass
*/
function parentfunc($paramie) {
if ($paramie) {
return 6;
} else {
return new babyclass;
}
}
}
/**
* @package sample1
*/
class babyclass extends myclass {
/**
* The answer to Life, the Universe and Everything
* @var integer
*/
var $secondvar = 42;
/**
* Configuration values
* @var array
*/
var $thirdvar;
/**
* Calls parent constructor, then increments {@link $firstvar}
*/
function babyclass() {
parent::myclass();
$this->firstvar++;
}
/**
* This always returns a myclass
* @param ignored $paramie
* @return myclass
*/
function parentfunc($paramie) {
return new myclass;
}
}
?>

本作品由Tim Zhang創(chuàng)作，采用知識共享署名 3.0 中國大陸許可協(xié)議進行許可。
。

總結(jié)

以上是生活随笔為你收集整理的php 参数 注释的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。