doxygen是個好用的程式設計師輔助工具,它可以讓程式加入批添程式碼更簡單輕鬆,相容於C++、 C、Java、 Objective-C、Python等主流程式語言,小編提供的doxygen中文手冊包含了基本介紹、文法技巧以及進階技巧等內容,可以讓你快速上手操作,有需要的歡迎下載。
基本介紹
Doxygen已經支援生成ANSI編碼的chm目錄檔案(index.hhc)!Doxygen通常是用作生成英文文檔的,生成中文文檔需要修改輸入和輸出的碼制,這樣可以改變解析方式,生成中文文檔。但是,你必須意識 到,Doxygen在從註釋中抽取資訊是需要做語法解析的,這些解析都是基於英文的基礎,不可能在這個層面上支持中文。
Doxygen 是一個 C++, C, Java, Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D語言的文檔產生器。可以運行在大多數類別Unix系統,以及Mac OS X作業系統和Microsoft Windows 。初始版本的Doxygen借鑒了一些舊版DOC++的程式碼;隨後,Doxygen原始碼由Dimitri van Heesch重寫。
doxygen手冊被分為三個部分,每個部分都包含若干章節。
第一部分是使用者指南
1. 安裝,討論如何在你的平台中下載,編譯和安裝 doxygen。
2. 開始,告訴你如何快速產生第一個 doxygen 文件。
3. 程式碼文件化,演示程式碼被文檔化的若干方法。
4. 列表,顯示建立列表的若干方法。
5. 組合,顯示如何將一些工作組合在一起。
6. 包含公式,顯示如何在文件中插入公式。
7. 圖形和圖表,描述doxygen 產生圖表和圖形。
8. 預處理,解析 doxygen 如何處理巨集定義。
9. 產生自動鏈接,顯示如何在文件中放置文件,類,成員的連結。
10. 輸出格式,顯示如何產生doxygen 支援的多種輸出格式。
11. 搜索,顯示在HTML 文件中進行搜索的若干方法。
12. 自訂輸出,解析如何在doxygen 中產生自訂的輸出。
13. 自訂指令,顯示如何在你的註解中定義和使用自訂的命令。
14. 連接到外部文檔,解析如何讓 doxygen 建立與外部已產生文檔的連結。
15. FAQ,對頻繁出現的提問給予的答案。
16. 排錯,當出現問題時,它會告訴你該做些什麼。
第二部分是參考指南
1. 特點,展示 doxygen 的功能概覽。
2. doxygen歷史,告知doxygen 在開發過程中的變化,以及它一直在進行的內容。
3. doxygen用法,告知如何使用 doxygen。
4. doxytag用法,告知如何使用 doxytag。
5. doxywizard用法,告知如何使用 doxywizard。
6. installdox用法,告知如果你使用 tag 文件,在 doxygen中如何使用生成的installdox腳本。
7. 配置,告知如何調整 doxygen,以便產生你需要的文件。
8. 特殊命令字,告知在文件中能使用的特殊命令的概覽。
9. HTML命令字,告知在文件中能使用的 HTML 指令的概覽。
10. XML命令字,告知在文件中能使用的 C#風格的 XML命令的概覽。
第三部分為doxygen開發者提供的一些資訊(略)
1. doxygen內部構造,給出 doxygen 內部結構的整體概覽。
2. Perl模組的輸出格式,顯示如何使用 PerlMod的輸出。
3. 國際化,解析如何新增語種的輸出支援。
本站所有資源都是由網友投搞發佈,或轉載各大下載站,請自行檢測軟件的完整性! 本站所有資源僅供學習與參攷,請勿用於商業用途,否則產生的一切後果將由您自己承擔! 如有侵權請聯繫我們删除下架,聯繫方式: admin@php.cn