熱點推薦:
您现在的位置: 電腦知識網 >> 編程 >> PHP編程 >> 正文

解析centos中Apache、php、mysql 默認安裝路徑

2013-11-15 12:30:57  來源: PHP編程 

  命令行方式
  在phpDocumentor所在目錄下輸入phpdoc –h會得到一個詳細的參數表其中幾個重要的參數如下
f 要進行分析的文件名多個文件用逗號隔開
d 要分析的目錄多個目錄用逗號分割
t 生成的文檔的存放路徑
o 輸出的文檔格式結構為輸出格式轉換器名模板目錄
例如phpdoc o HTML:frames:earthli f testphp t docs

  Web界面生成
  在新的phpdoc中除了在命令行下生成文檔外還可以在客戶端浏覽器上操作生成文檔具體方法是先把PhpDocumentor的內容放在apache目錄下使得通過浏覽器可以訪問到訪問後顯示如下的界面
點擊files按鈕選擇要處理的php文件或文件夾還可以通過該指定該界面下的Files to ignore來忽略對某些文件的處理
然後點擊output按鈕來選擇生成文檔的存放路徑和格式
最後點擊createphpdocumentor就會自動開始生成文檔了最下方會顯示生成的進度及狀態如果成功會顯示
Total Documentation Time: seconds
done
Operation Completed!!
然後我們就可以通過查看生成的文檔了如果是pdf格式的名字默認為documentationpdf
給php代碼添加規范的注釋

  PHPDocument是從你的源代碼的注釋中生成文檔因此在給你的程序做注釋的過程也就是你編制文檔的過程
從這一點上講PHPdoc促使你要養成良好的編程習慣盡量使用規范清晰文字為你的程序做注釋同時多多少少也避免了事後編制文檔和文檔的更新不同步的一些問題
在phpdocumentor中注釋分為文檔性注釋和非文檔性注釋
所謂文檔性注釋是那些放在特定關鍵字前面的多行注釋特定關鍵字是指能夠被phpdoc分析的關鍵字例如classvar等具體的可參加附錄
那些沒有在關鍵字前面或者不規范的注釋就稱作非文檔性注釋這些注釋將不會被phpdoc所分析也不會出現在你產生的api文當中

  如何書寫文檔性注釋:
  所有的文檔性注釋都是由/**開始的一個多行注釋在 phpDocumentor裡稱為DocBlock DocBlock是指軟件開發人員編寫的關於某個關鍵字的幫助信息使得其他人能夠通過它知道這個關鍵字的具體用途如何使用 PhpDocumentor規定一個DocBlock包含如下信息
功能簡述區
詳細說明區
標記tag
  文檔性注釋的第一行是功能描述區正文一般是簡明扼要地說明這個類方法或者函數的功能功能簡述的正文在生成的文檔中將顯示在索引區功能描述區的內容可以通過一個空行或者 來結束

在 功能描述區後是一個空行接著是詳細說明區 這部分主要是詳細說明你的API的功能用途如果可能也可以有用法舉例等等在這部分你應該著重闡明你的API函數或者方法的通常的用途用法並 且指明是否是跨平台的(如果涉及到)對於和平台相關的信息你要和那些通用的信息區別對待通常的做法是另起一行然後寫出在某個特定平台上的注意事項 或者是特別的信息這些信息應該足夠以便你的讀者能夠編寫相應的測試信息比如邊界條件參數范圍斷點等等

之後同樣是一個空白行然後是文檔的標記tag指明一些技術上的信息主要是最主要的是調用參數類型返回值極其類型繼承關系相關方法/函數等等

文檔注釋中還可以使用例如<b> <code>這樣的標簽詳細介紹請參考附錄二
一個文檔注釋的例子
/**
* 函數add實現兩個數的加法
*
* 一個簡單的加法計算函數接受兩個數ab返回他們的和c
*
* @param int 加數
* @param int 被加數
* @return integer
*/
function Add($a $b)
{
return $a+$b;
}
生成文檔如下
Add
integer Add( int $a int $b)
[line ]
函數add實現兩個數的加法
Constants 一個簡單的加法計算函數接受兩個數ab返回他們的和c
Parameters
• int $a 加數
• int $b 被加數
文檔標記
  文檔標記的使用范圍是指該標記可以用來修飾的關鍵字或其他文檔標記
所有的文檔標記都是在每一行的 * 後面以@開頭如果在一段話的中間出來@的標記這個標記將會被當做普通內容而被忽略掉
@access
  使用范圍classfunctionvardefinemodule
該標記用於指明關鍵字的存取權限privatepublic或proteced
@author
  指明作者
@copyright
  使用范圍classfunctionvardefinemoduleuse
指明版權信息
@deprecated
  使用范圍classfunctionvardefinemoduleconstentglobalinclude
指明不用或者廢棄的關鍵字
@example
  該標記用於解析一段文件內容並將他們高亮顯示Phpdoc會試圖從該標記給的文件路徑中讀取文件內容
@const
  使用范圍define
用來指明php中define的常量
@final
  使用范圍classfunctionvar
指明關鍵字是一個最終的類方法屬性禁止派生修改
@filesource
  和example類似只不過該標記將直接讀取當前解析的php文件的內容並顯示
@global
  指明在此函數中引用的全局變量
@ingore
  用於在文檔中忽略指定的關鍵字
@license
  相當於html標簽中的<a>首先是URL接著是要顯示的內容
例如<a href=”百度</a>
可以寫作 @license 百度
@link
  類似於license
但還可以通過link指到文檔中的任何一個關鍵字
@name
  為關鍵字指定一個別名
@package
  使用范圍頁面級別的> definefunctioninclude
類級別的>classvarmethods
用於邏輯上將一個或幾個關鍵字分到一組
@abstrcut
  說明當前類是一個抽象類
@param
  指明一個函數的參數
@return
  指明一個方法或函數的返回指
@static
  指明關建字是靜態的
@var
  指明變量類型
@version
  指明版本信息
@todo
  指明應該改進或沒有實現的地方
@throws
  指明此函數可能拋出的錯誤異常極其發生的情況
上面提到過普通的文檔標記標記必須在每行的開頭以@標記除此之外還有一種標記叫做inline tag用{@}表示具體包括以下幾種
{@link}
用法同@link
{@source}
顯示一段函數或方法的內容

  一些注釋規范
a注釋必須是
/**
* XXXXXXX
*/
的形式
b對於引用了全局變量的函數必須使用glboal標記
c對於變量必須用var標記其類型(intstringbool
d函數必須通過param和return標記指明其參數和返回值
e對於出現兩次或兩次以上的關鍵字要通過ingore忽略掉多余的只保留一個即可
f調用了其他函數或類的地方要使用link或其他標記鏈接到相應的部分便於文檔的閱讀
g必要的地方使用非文檔性注釋提高代碼易讀性
h描述性內容盡量簡明扼要盡可能使用短語而非句子
i全局變量靜態變量和常量必須用相應標記說明

  總結
phpDocumentor是一個非常強大的文檔自動生成工具利用它可以幫助我們編寫規范的注釋生成易於理解結構清晰的文檔對我們的代碼升級維護移交等都有非常大的幫助
關於phpDocumentor更為詳細的說明可以到它的官方網站

  兩個例子
實例一
實例二


From:http://tw.wingwit.com/Article/program/PHP/201311/21093.html
    推薦文章
    Copyright © 2005-2013 電腦知識網 Computer Knowledge   All rights reserved.