基本介紹
- 外文名：phpDocumentor
- 語言：PHP
- 作用：生成具有相互參照，索引API文檔
- 舊稱：phpdoc
軟體安裝,生成文檔,文檔注釋,文檔標記,注釋規範,附錄,
軟體安裝
phpDocumentor和其他pear下的模組一樣，phpDocumentor的安裝也分為自動安裝和手動安裝兩種方式，兩種方式都非常方便：
a． 通過pear 自動安裝
在命令行下輸入
pear install PhpDocumentor
b． 手動安裝
在http://manual.phpdoc.org/下載最新版本的PhpDocumentor（現在是1.4.0），把內容解壓即可。
生成文檔
命令行方式：
在phpDocumentor所在目錄下，輸入
phpdoc –h
會得到一個詳細的參數表，其中幾個重要的參數如下：
-f 要進行分析的檔案名稱，多個檔案用逗號隔開
-d 要分析的目錄，多個目錄用逗號分割
-t 生成的文檔的存放路徑
-o 輸出的文檔格式，結構為輸出格式：轉換器名：模板目錄。
例如：phpdoc -o HTML:frames:earthli -f test.php -t docs
Web界面生成
在新的phpdoc中，除了在命令行下生成文檔外，還可以在客戶端瀏覽器上操作生成文檔，具體方法是先把PhpDocumentor的內容放在apache目錄下使得通過瀏覽器可以訪問到，訪問後顯示如下的界面：
點擊files按鈕，選擇要處理的php檔案或資料夾，還可以通過該指定該界面下的Files to ignore來忽略對某些檔案的處理。
然後點擊output按鈕來選擇生成文檔的存放路徑和格式.
最後點擊create，phpdocumentor就會自動開始生成文檔了，最下方會顯示生成的進度及狀態，如果成功，會顯示
Total Documentation Time: 1 seconds
done
Operation Completed!!
然後，我們就可以通過查看生成的文檔了，如果是pdf格式的，名字默認為documentation.pdf。
文檔注釋
給php代碼添加規範的注釋
PHPDocument是從你的原始碼的注釋中生成文檔，因此在給你的程式做注釋的過程，也就是你編制文檔的過程。
從這一點上講，PHPdoc促使你要養成良好的編程習慣，儘量使用規範，清晰文字為你的程式做注釋，同時多多少少也避免了事後編制文檔和文檔的更新不同步的一些問題。
在phpdocumentor中，注釋分為文檔性注釋和非文檔性注釋。
所謂文檔性注釋，是那些放在特定關鍵字前面的多行注釋，特定關鍵字是指能夠被phpdoc分析的關鍵字，例如class，var等，具體的可參加附錄1.
那些沒有在關鍵字前面或者不規範的注釋就稱作非文檔性注釋，這些注釋將不會被phpdoc所分析，也不會出現在你產生的api文檔中。
如何書寫文檔性注釋
所有的文檔性注釋都是由/**開始的一個多行注釋，在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 - 被加數
文檔標記
文檔標記的使用範圍是指該標記可以用來修飾的關鍵字，或其他文檔標記。
所有的文檔標記都是在每一行的 * 後面以@開頭。如果在一段話的中間出來@的標記，這個標記將會被當做普通內容而被忽略掉。
@access
使用範圍：class,function,var,define,module
該標記用於指明關鍵字的存取許可權：private、public或proteced
@author
指明作者
@copyright
使用範圍：class，function，var，define，module，use
指明版權資訊
@deprecated
指明不用或者廢棄的關鍵字
@example
該標記用於解析一段檔案內容，並將他們高亮顯示。Phpdoc會試圖從該標記給的檔案路徑中讀取檔案內容
使用範圍：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
為關鍵字指定一個別名。
使用範圍：頁面級別的-> define，function，include
類級別的->class，var，methods
用於邏輯上將一個或幾個關鍵字分到一組。
@abstrcut
說明當前類是一個抽象類
指明一個函式的參數
@return
指明一個方法或函式的返回值
指明關建字是靜態的。
@var
指明變數類型
@version
指明版本信息
@todo
指明應該改進或沒有實現的地方
@throws
指明此函式可能拋出的錯誤異常,極其發生的情況
上面提到過，普通的文檔標記標記必須在每行的開頭以@標記，除此之外，還有一種標記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函式或方法的內容
注釋規範
a.注釋必須是
/**
* XXXXXXX
*/
的形式
b.對於引用了全局變數的函式，必須使用glboal標記。
d.函式必須通過param和return標記指明其參數和返回值
e.對於出現兩次或兩次以上的關鍵字，要通過ignore忽略掉多餘的，只保留一個即可
f.調用了其他函式或類的地方，要使用link或其他標記連結到相應的部分，便於文檔的閱讀。
g.必要的地方使用非文檔性注釋，提高代碼易讀性。
h.描述性內容儘量簡明扼要，儘可能使用短語而非句子。
i.全局變數，靜態變數和常量必須用相應標記說明
附錄
附錄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 <[email protected]>
* @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')
{
static $staticvar = 7;
global $_myvar;
return $staticvar;
}
/**
* The first example class, this is in the same package as the
* procedural stuff in the start of the file
* @package sample
* @subpackage classes
*/
class myclass {
/**
* A sample private variable, this can be hidden with the --parseprivate
* option
* @access private
* @var integer|string
*/
var $firstvar = 6;
/**
* @link http://www.example.com Example link
* @see myclass()
* @uses testing, anotherconstant
* @var array
*/
var $secondvar =
array(
'stuff' =>
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;
}
}
?>
