A. 如何做好 php 項目文檔管理
對於常年寫 PHP 的老司機來說，PHPDoc 一定不會陌生，不過從1.3.0開始，更名為 phpDocumentor。它作為一個用 PHP 寫的工具，主要作用是從你的源代碼的注釋中生成文檔，因此在給你的程序做注釋的過程，也就是你編制文檔的過程。這樣也促使你要養成良好的編程習慣，盡量使用規范，也避免了事後編制文檔和文檔的更新不同步的一些問題。新的版本加上了對 php5 語法的支持，同時，可以通過在客戶端瀏覽器上操作生成文檔，文檔可以轉換為 pdf、HTML、CHM幾種形式，非常的方便。不過，傳統使用 PHPDoc 工具需要下載安裝，過程繁瑣，今天給大家推薦碼雲 PHP 項目的文檔自動生成和託管服務。
首先確保項目的編程語言選項是 PHP如果不是 PHP，請進入項目設置頁面，修改編程語言為 PHP。
點擊服務菜單中的 PHPDoc 項目
選擇要構建文檔的分支以及目錄4. 開始自動生成文檔並部署
B. httpd.exe--應用程序錯誤"0x01682ba"指令引用的"0x00000000"內存。該內存不能為"read"。
成功完美解決方案：在php裡面關閉不必要的dll文件鏈接。
（因為我是新手，所以暫時全部關閉。至於要開啟那些dll文件，個人需要）
PHP配置文件詳解php.ini已經翻譯為中文http://www.cnblogs.com/hbl/archive/2008/02/15/1069367.html）
;[PHP_BZ2]
;extension=php_bz2.dll
;[PHP_CURL]
;extension=php_curl.dll
;[PHP_DBA]
;extension=php_dba.dll
;[PHP_DBASE]
;extension=php_dbase.dll
;[PHP_EXIF]
;extension=php_exif.dll
;[PHP_FDF]
;extension=php_fdf.dll
;[PHP_GD2]
;extension=php_gd2.dll
;[PHP_GETTEXT]
;extension=php_gettext.dll
;[PHP_GMP]
;extension=php_gmp.dll
;[PHP_IMAP]
;extension=php_imap.dll
;[PHP_INTERBASE]
;extension=php_interbase.dll
;[PHP_LDAP]
;extension=php_ldap.dll
;[PHP_MBSTRING]
;extension=php_mbstring.dll
;[PHP_MCRYPT]
;extension=php_mcrypt.dll
;[PHP_MHASH]
;extension=php_mhash.dll
;[PHP_MIME_MAGIC]
;extension=php_mime_magic.dll
;[PHP_MING]
;extension=php_ming.dll
;[PHP_MSQL]
;extension=php_msql.dll
;[PHP_MSSQL]
;extension=php_mssql.dll
;[PHP_MYSQL]
;extension=php_mysql.dll
;[PHP_MYSQLI]
;extension=php_mysqli.dll
;[PHP_OCI8]
;extension=php_oci8.dll
;[PHP_OPENSSL]
;extension=php_openssl.dll
;[PHP_PDO]
;extension=php_pdo.dll
;[PHP_PDO_FIREBIRD]
;extension=php_pdo_firebird.dll
;[PHP_PDO_MSSQL]
;extension=php_pdo_mssql.dll
;[PHP_PDO_MYSQL]
;extension=php_pdo_mysql.dll
;[PHP_PDO_OCI]
;extension=php_pdo_oci.dll
;[PHP_PDO_OCI8]
;extension=php_pdo_oci8.dll
;[PHP_PDO_ODBC]
;extension=php_pdo_odbc.dll
;[PHP_PDO_PGSQL]
;extension=php_pdo_pgsql.dll
;[PHP_PDO_SQLITE]
;extension=php_pdo_sqlite.dll
;[PHP_PDO_SQLITE_EXTERNAL]
;extension=php_pdo_sqlite_external.dll
;[PHP_PGSQL]
;extension=php_pgsql.dll
;[PHP_PSPELL]
;extension=php_pspell.dll
;[PHP_SHMOP]
;extension=php_shmop.dll
;[PHP_SNMP]
;extension=php_snmp.dll
;[PHP_SOAP]
;extension=php_soap.dll
;[PHP_SOCKETS]
;extension=php_sockets.dll
;[PHP_SQLITE]
;extension=php_sqlite.dll
;[PHP_SYBASE_CT]
;extension=php_sybase_ct.dll
;[PHP_TIDY]
;extension=php_tidy.dll
;[PHP_XMLRPC]
;extension=php_xmlrpc.dll
;[PHP_XSL]
;extension=php_xsl.dll
;[PHP_ZIP]
;extension=php_zip.dll
;[PHP_ADT]
;extension=php_adt.dll
;[PHP_APC]
;extension=php_apc.dll
;[PHP_APD]
;extension=php_apd.dll
;[PHP_BCOMPILER]
;extension=php_bcompiler.dll
;[PHP_BITSET]
;extension=php_bitset.dll
;[PHP_BLENC]
;extension=php_blenc.dll
;[PHP_BZ2_FILTER]
;extension=php_bz2_filter.dll
;[PHP_CLASSKIT]
;extension=php_classkit.dll
;[PHP_CPDF]
;extension=php_cpdf.dll
;[PHP_CRACK]
;extension=php_crack.dll
;[PHP_CVSCLIENT]
;extension=php_cvsclient.dll
;[PHP_DB]
;extension=php_db.dll
;[PHP_DBX]
;extension=php_dbx.dll
;[PHP_DIO]
;extension=php_dio.dll
;[PHP_DOCBLOCK]
;extension=php_docblock.dll
;[PHP_DOMXML]
;extension=php_domxml.dll
;[PHP_EVENT]
;extension=php_event.dll
;[PHP_FILEINFO]
;extension=php_fileinfo.dll
;[PHP_FILEPRO]
;extension=php_filepro.dll
;[PHP_FRIBIDI]
;extension=php_fribidi.dll
;[PHP_GOPHER]
;extension=php_gopher.dll
;[PHP_HARU]
;extension=php_haru.dll
;[PHP_HTSCANNER]
;extension=php_htscanner.dll
;[PHP_HTTP]
;extension=php_http.dll
;[PHP_HYPERWAVE]
;extension=php_hyperwave.dll
;[PHP_IBM_DB2]
;extension=php_ibm_db2.dll
;[PHP_ID3]
;extension=php_id3.dll
;[PHP_IFX]
;extension=php_ifx.dll
;[PHP_IISFUNC]
;extension=php_iisfunc.dll
;[PHP_IMAGICK]
;extension=php_imagick.dll
;[PHP_INGRES]
;extension=php_ingres.dll
;[PHP_java]
;extension=php_java.dll
;[PHP_LZF]
;extension=php_lzf.dll
;[PHP_MAILPARSE]
;extension=php_mailparse.dll
;[PHP_MAXDB]
;extension=php_maxdb.dll
;[PHP_MCRYPT_FILTER]
;extension=php_mcrypt_filter.dll
;[PHP_MCVE]
;extension=php_mcve.dll
;[PHP_MEMCACHE]
;extension=php_memcache.dll
;[PHP_NETOOLS]
;extension=php_netools.dll
;[PHP_NTUSER]
;extension=php_ntuser.dll
;[PHP_OGGVORBIS]
;extension=php_oggvorbis.dll
;[PHP_OPERATOR]
;extension=php_operator.dll
;[PHP_ORACLE]
;extension=php_oracle.dll
;[PHP_PARSEKIT]
;extension=php_parsekit.dll
;[PHP_PDF]
;extension=php_pdf.dll
;[PHP_PDO_IBM]
;extension=php_pdo_ibm.dll
;[PHP_PDO_INFORMIX]
;extension=php_pdo_informix.dll
;[PHP_PHAR]
;extension=php_phar.dll
;[PHP_PHPDOC]
;extension=php_phpdoc.dll
;[PHP_POP3]
;extension=php_pop3.dll
;[PHP_PRINTER]
;extension=php_printer.dll
;[PHP_RADIUS]
;extension=php_radius.dll
;[PHP_RAR]
;extension=php_rar.dll
;[PHP_RUNKIT]
;extension=php_runkit.dll
;[PHP_SAM]
;extension=php_sam.dll
;[PHP_SDO]
;extension=php_sdo.dll
;[PHP_SMTP]
;extension=php_smtp.dll
;[PHP_SSH2]
;extension=php_ssh2.dll
;[PHP_STATS]
;extension=php_stats.dll
;[PHP_STEM]
;extension=php_stem.dll
;[PHP_SVN]
;extension=php_svn.dll
;[PHP_SWISH]
;extension=php_swish.dll
;[PHP_THREADS]
;extension=php_threads.dll
;[PHP_TIMEZONEDB]
;extension=php_timezonedb.dll
;[PHP_TRANSLIT]
;extension=php_translit.dll
;[PHP_UPLOADPROGRESS]
;extension=php_uploadprogress.dll
;[PHP_WIN32PS]
;extension=php_win32ps.dll
;[PHP_WIN32SCHEDULER]
;extension=php_win32scheler.dll
;[PHP_WIN32SERVICE]
;extension=php_win32service.dll
;[PHP_WIN32STD]
;extension=php_win32std.dll
;[PHP_ZLIB_FILTER]
;extension=php_zlib_filter.dll
C. 如何正確安裝phpDocumentor
phpDocumentor是一個用PHP寫的工具，對於有規范注釋的php程序，它能夠快速生成具有相互參照,索引等功能的API文檔。老的版本是
phpdoc。
1. 什麼是phpDocumentor ?
PHPDocumentor是一個用PHP寫的工具，對於有規范注釋的php程序，它能夠快速生成具有相互參照,索引等功能的API文檔。老的版本是
phpdoc，從1.3.0開始，更名為phpDocumentor，新的版本加上了對php5語法的支持，同時，可以通過在客戶端瀏覽器上操作生成文檔，文檔可以轉換為PDF,HTML,CHM幾種形式，非常的方便。
PHPDocumentor工作時，會掃描指定目錄下面的php源代碼，掃描其中的關鍵字，截取需要分析的注釋，然後分析注釋中的專用的tag，生成
xml文件，接著根據已經分析完的類和模塊的信息，建立相應的索引，生成xml文件，對於生成的xml文件，使用定製的模板輸出為指定格式的文件。
2. 安裝phpDocumentor
和其他pear下的模塊一樣，phpDocumentor的安裝也分為自動安裝和手動安裝兩種方式，兩種方式都非常方便：
a． 通過pear 自動安裝
在命令行下輸入
pear install PhpDocumentor
b． 手動安裝
在http://manual.phpdoc.org/下載最新版本的PhpDocumentor（現在是1.4.0），把內容解壓即可。
3．怎樣使用PhpDocumentor生成文檔
命令行方式：
在phpDocumentor所在目錄下，輸入
Php –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。
4．給php代碼添加規范的注釋
PHPDocument是從你的源代碼的注釋中生成文檔，因此在給你的程序做注釋的過程，也就是你編制文檔的過程。
從這一點上講，PHPdoc促使你要養成良好的編程習慣，盡量使用規范，清晰文字為你的程序做注釋，同時多多少少也避免了事後編制文檔和文檔的更新不同步的一些問題。
在phpdocumentor中，注釋分為文檔性注釋和非文檔性注釋。
所謂文檔性注釋，是那些放在特定關鍵字前面的多行注釋，特定關鍵字是指能夠被phpdoc分析的關鍵字，例如class，var等，具體的可參加附錄1.
那些沒有在關鍵字前面或者不規范的注釋就稱作非文檔性注釋，這些注釋將不會被phpdoc所分析，也不會出現在你產生的api文當中。
3.2如何書寫文檔性注釋:
所有的文檔性注釋都是由
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,mole
該標記用於指明關鍵字的存取許可權：PRivate、public或proteced
@author
指明作者
@right
使用范圍：class，function，var，define，mole，use
指明版權信息
@deprecated
使用范圍：class，function，var，define，mole，constent，global，include
指明不用或者廢棄的關鍵字
@example
該標記用於解析一段文件內容，並將他們高亮顯示。Phpdoc會試圖從該標記給的文件路徑中讀取文件內容
@const
使用范圍：define
用來指明php中define的常量
@final
使用范圍：class,function,var
指明關鍵字是一個最終的類、方法、屬性，禁止派生、修改。
@filesource
和example類似，只不過該標記將直接讀取當前解析的php文件的內容並顯示。
@global
指明在此函數中引用的全局變數
@ingore
用於在文檔中忽略指定的關鍵字
@license
相當於html標簽中的<a>,首先是URL，接著是要顯示的內容
例如<a
href=」http://www..com」>網路</a>
可以寫作 @license http://www..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.注釋必須是
的形式
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 #1
include_once 'sample3.php';
$GLOBALS['_myvar'] = 6;
define('testing', 6);
define('anotherconstant',
strlen('hello'));
function firstFunc($param1, $param2
= 'optional') {
static $staticvar = 7;
global $_myvar;
return $staticvar;
}
class myclass {
var $firstvar = 6;
var $secondvar =
array(
'stuff' =>
array(
6,
17,
'armadillo'
),
testing => anotherconstant
);
function myclass() {
$this->firstvar =
7;
}
function parentfunc($paramie)
{
if ($paramie) {
return 6;
} else {
return new babyclass;
}
}
}
class babyclass extends myclass
{
var $secondvar = 42;
var $thirdvar;
function babyclass() {
parent::myclass();
$this->firstvar++;
}
function parentfunc($paramie)
{
return new myclass;
}
}
?>
D. xampp如何安裝phpDocumentor
安裝phpDocumentor第一種方法：
下 載後，如果希望使用命令行介面，解壓到任意路徑（假設在C:\Program Files\），修改C:\Program Files\PhpDocumentor-1.4.2\phpdoc.bat。把第一行修改SET phpCli=C:\usr\local\php\cli\php.exe令等號右邊的值為php.exe的路徑，我的機器是SET phpCli=D:\php5\php.exe。
在命令行輸入C:\Program Files\PhpDocumentor-1.4.2\phpdoc,其實是一個批處理文件，會出現一個dos界面，給你選擇ini文件。後面就不知道了。
如果想使用web介面，你必須先把apache和php裝好，把PhpDocumentor-1.4.2這個文件夾拷貝到文檔根目錄下，然後在瀏覽器url欄輸入：
http://localhost/PhpDocumentor-1.4.2/phpdoc.php
然後瀏覽器會自動跳轉，選擇index.html,後面的操作就很簡單了。
安裝phpDocumentor第二種方法：
通過pear安裝，進入dos的php目錄，輸入pear install -a PhpDocumentor。如果想使用web介面，則必須首先改變一個配置，
pear config-set data_dir /path/to/document_root/pear。最後的路徑應該是/php文檔根路徑/pear(也可以在web介面中改變這個值)。我沒在第二種方法的web介面試驗成功。
如果使用web介面的話，還有選擇，一種是每次都選擇輸入文件，輸出文件之類。另一種是使用一個配置文件，裡面把什麼都定義好，進入頁面後，先選擇這個配置文件，然後點擊「創建」按鈕，