Mais conteúdo relacionado Semelhante a Php documentor (20) Php documentor2. 文件的重要 “Writing good documentation is essential to the success of any software project.”http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html 特別是 OOS 項目 2011 Aircamel Copyright 2 6. Example PEAR API Documentation http://pear.php.net/package/Auth/docs/latest/ Zend Framework http://framework.zend.com/apidoc/core symfony http://www.symfony-project.org/api/1_2 2011 Aircamel Copyright 6 7. How to Install phpDocumentor的安裝分為自動安裝和手動安裝兩種方式 通過pear 自動安裝pear install PhpDocumentor 手動安裝在http://manual.phpdoc.org/下載最新版本的PhpDocumentor把內容解壓即可。 2011 Aircamel Copyright 7 9. DocBlock /*** Short description ** Long description. This is an sample function * to show the DocBlock format.** 2nd paragraph of long description. * * * @tag1 * @tag2 */ 2011 Aircamel Copyright 9 12. Long Description /*** - unordered item A * - unordered item B * * 1 ordered item A * 2 ordered item B */ 2011 Aircamel Copyright 12 13. Long Description 無長度限制 可以多行 一些HTML標籤使用 b, code, br, i, kbd, li, ol, p, pre, samp, ul, var 2011 Aircamel Copyright 13 16. @license 顯示版權及 URL 例: @license http://opensource.org/licenses/api/licenese.php GUN Public License 2011 Aircamel Copyright 16 @license authorname<name@example.com> 18. @param 變數及型態的說明 PHP 內的類型提示(Type Hinting) 例: @paramint $num @parambool|string $foo a bool or string param 2011 Aircamel Copyright 18 @paramdatatype$paramnamedescription 19. @return 函數回傳表示 回傳值的型態 例: @return mixed @return fooClass|falsefooClass object or error 2011 Aircamel Copyright 19 @return datatypedescript 21. DocBlock Template /**#@+* @access private* @var string*/var $_var1 = ‘Hello’;var $_var2 = ‘World’;...var $_varN;/**#@-*///下面的說明,不適用var $varX = array(); 2011 Aircamel Copyright 21 24. Template 你可以自己/選擇輸出格式 HTML - Smart CHM - Windows help 的模板可 PDF - Adobe Acrobat 形式 XML:DocBook的 - 可重複使用為出發 2011 Aircamel Copyright 24