phpdoc注釋格式及文件生成

2022-03-12 16:36:16 字數 1039 閱讀 5652

舊版本使用步驟

1、win下安裝pear

$file = '';

$file2 = 'f:\go-pear.phar';

// open the file to get existing content

$current = file_get_contents($file);

// write the contents back to the file

將go-pear.phar複製到php.exe同目錄下,cd進入該目錄,執行php -d phar.require_hash=0 go-pear.phar命令,選擇local,一路enter,完成後,該目錄下會出現pear有關的目錄和bat檔案。

2、以phpdocumentor為例使用pear

pear install phpdocumentor

3、命令生成

phpdoc -d "

f:\phpdoc\1

" -t "

f:\phpdoc\doc

" -o "

html:frames:phpedit

"

新版本使用步驟(v3.1.2)

1.php >=7.2;

3.執行文件生成命令php phpdocumentor.phar -d f:\myproject\ -t f:\docs\ #注意目錄不帶引號

常用命令:-d,-t,-f

-d指出專案**目錄;

-f指出**檔案;

-t指出輸出目錄;

執行無誤後,會在-t目錄下生成對應的html文件檔案。

v3.1.2文件注釋格式

PHP之文件注釋規範PHPDoc

良好的文件注釋不但能使 易於維護,而且可以通過phpdocumentor等文件生成工具生成專案手冊,以便於查閱。此外php的弱型別特徵更應該引起我們對文件注釋的重視!本文簡單的介紹下phpdoc文件注釋,以及常用的一些標籤。1.文件注釋並不只是用來注釋整個檔案的,在元素前面宣告之後,它可以和該特定的...

使用C XML 文件注釋生成API幫助文件

c xml 文件注釋 description 描述型別或型別成員。description 物件的摘要。description 新增有關某個型別的資訊,從而補充由 所指定的資訊。description 成員的說明。description 使用方法或其他庫成員的示例。這通常涉及使用標記。descript...

將C 文件注釋生成 chm幫助文件

完整的文件情訪問 由於最近需要把以前的乙個專案寫乙個文件,但一時又不知道寫成怎樣的,又恰好發現了可以生成chm的工具,於是乎我就研究了下,感覺還不錯,所以也給大家分享下。好了,不多廢話,下面就來實現一下吧。生成前的準備 在開始做之前,還是要補充說明一點 我們是通過c 文件注釋生成的xml檔案來生成幫...