php 參數 注釋

簡介：這是php 參數 注釋的詳細頁面，介紹了和php,有關的知識、技巧、經驗，和一些php源碼等。

class='pingjiaF' frameborder='0' src='http://biancheng.dnbcw.info/pingjia.php?id=340853' scrolling='no'>

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

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

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

使用範圍：define
用來指明php中define的常量
@final
使用範圍：class,function,var
指明關鍵字是一個最終的類、方法、屬性，禁止派生、修改。
@filesource
和example類似，只不過該標記將直接讀取當前解析的php檔案的內容並顯示。
@global
指明在此函數中引用的全域變數
@ingore
用於在文檔中忽略指定的關鍵字
@license
相當於html標籤中的<a>,首先是URL，接著是要顯示的內容
例如<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
指明一個函數的參數
@return
指明一個方法或函數的返回指
@static
指明關建字是靜態。
@var
指明變數類型
@version
指明版本資訊
@todo
指明應該改進或沒有實現的地方
@throws
指明此函數可能拋出的錯誤異常,極其發生的情況
上面提到過，普通的文檔標記標記必須在每行的開頭以@標記，除此之外，還有一種標記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函數或方法的內容
6．一些注釋規範
a.注釋必須是
/**
* XXXXXXX
*/
的形式
b.對於引用了全域變數的函數，必須使用glboal標記。
c.對於變數，必須用var標記其類型（int,string,bool...）
d.函數必須通過param和return標記指明其參數和傳回值
e.對於出現兩次或兩次以上的關鍵字，要通過ingore忽略掉多餘的，只保留一個即可
f.調用了其他函數或類的地方，要使用link或其他標記連結到相應的部分，便於文檔的閱讀。
g.必要的地方使用非文檔性注釋，提高代碼易讀性。
h.描述性內容盡量簡明扼要，儘可能使用短語而非句子。
i.全域變數，靜態變數和常量必須用相應標記說明
7. 總結
phpDocumentor是一個非常強大的文檔自動產生工具，利用它可以協助我們編寫規範的注釋，產生易於理解，結構清晰的文檔，對我們的代碼升級，維護,移交等都有非常大的協助。
關於phpDocumentor更為詳細的說明，可以到它的官方網站
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>
附錄三：
一段含有規範注釋的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;}}?>

愛J2EE關注Java邁克爾傑克遜視頻站JSON線上工具

http://biancheng.dnbcw.info/php/340853.html pageNo:7