天天看點

使用Doxygen生成C#幫助文檔

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t0">一 什麼是Doxygen</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t1">二 準備軟體</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t2">1 doxygen</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t3">2 graphviz</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t4">3 Microsoft HTML Help Workshop</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t5">三 C注釋</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t6">四 配置</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t7">1 Doxygen工作目錄</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t8">2 Wizard 向導</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t9">      421 Project 項目</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t10">      422 Mode 模式</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t11">      423 Output 輸出</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t12">      424 Diagrams 圖表</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t13">3 Export 導出</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t14">      431 Project  項目</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t15">      432 Build 建構</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t16">      433 Input 輸入</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t17">      434 Index 索引</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t18">      435 HTML</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t19">      436 Dot</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t20">五Run 運作</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t21">六HTML效果圖</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t22">七CHM效果圖</a>

<a href="http://www.cnblogs.com/zhaoqingqing/p/3842236.html#t23">八提醒</a>

Doxygen 是一個程式的檔案産生工具,可将程式中的特定批注轉換成為說明檔案。通常我們在寫程式時,或多或少都會寫上批注,但是對于其它人而言,要直接探索程式裡的批注,與打撈鐵達尼号同樣的辛苦。大部分有用的批注都是屬于針對函式,類别等等的說明。是以,如果能依據程式本身的結構,将批注經過處理重新整理成為一個純粹的參考手冊,對于後面利用您的程式代碼的人而言将會減少許多的負擔。不過,反過來說,整理檔案的工作對于您來說,就是沉重的負擔。

Doxygen 就是在您寫批注時,稍微按照一些它所制訂的規則。接着,他就可以幫您産生出漂亮的文檔了。

是以,Doxygen 的使用可分為兩大部分。首先是特定格式的批注撰寫,第二便是利用Doxygen的工具來産生文檔。

使用Doxygen生成C#幫助文檔

注:這個軟體不是必需的,如果需要使用更強大的功能比如類繼承體系圖等則需要安裝此軟體配置使用,需要安裝Java環境

使用Doxygen生成C#幫助文檔

chm檔案制作工具

三個軟體

使用Doxygen生成C#幫助文檔

請選擇一個已存在的非中文路徑的檔案夾,如下圖:

使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔

将With search function的鈎去掉

使用Doxygen生成C#幫助文檔

plain HTML,為下圖一,with navigation panel為下圖二

使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔

(Use built-in class diagram generator)将使用内置的生成功能生成每個類的類圖,隻有一個類是不為生成的。

如果需要更加大的功能比如類繼承體系圖請選擇第三項(Use dot tool from the GraphViz package)需要安GraphViz。

OUTPUT_LANGUAGE選擇chinese TAB_SIZE是Tab的長度

使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔

預設是會生成public方法,這裡也選擇EXTRACT_ALL。它保證輸出所有public方法及project方法,EXTRACT_STATIC是生成靜态方法。

使用Doxygen生成C#幫助文檔

Input為輸入目錄,支援多個目錄,我們可以放入項目目錄和include目錄,下面的Exclude是忽略目錄與檔案,可自行添加。

使用Doxygen生成C#幫助文檔

選擇ALPHABETICAL_INDEX,類中将有一個組合類型索引項。

使用Doxygen生成C#幫助文檔

生成的索引如下圖所示

使用Doxygen生成C#幫助文檔

如果你之前選擇了(prepare form compressed HTML(.chm))這裡抽GENERATE_HTMLHELP項會是選擇狀态,它下面的CHM_FILE填寫你的CHM文檔的名字(要加上.chm)。HHC_LOCATION則選擇你的HTML Help WorkShop安裝目錄下的HHC程式,一般會在C:/Program Files (x86)/HTML Help Workshop/hhc.exe。選擇TOC_EXPAND會生成左邊的樹目錄。

使用Doxygen生成C#幫助文檔

如果你選用内置的生成功能(Use build-in class diagram generator)此時CLASS_DIAGRAMS會是選擇狀态,而HAV_DOT是未選擇狀态,如果你選擇用GraphViz的dot工具生成(Use dot tool from the GraphViz package)情況則相反,請你選擇上CLASS_DIAGRAMS。此時你需要設定下面的DOT_PATH為GraphViz的安裝目錄,否則将無法生成。

另外以下選項選擇則生成對應的圖,不選擇則不生成。

CLASS_GRAPHS                   類圖

COLLABORATION_GRAPH      協作圖

GROUP_GRAPHS                   組圖

UML_LOOK                           是否UML外觀

INCLUDE_GRAPH                   include

INCLUDED BY GRAPH             被include

CALL_GRAPH                        調用

CALLER_GRAPH                    被調用

DIRECTORY_GRAPH               目錄圖

GRAPHICAL_HIERARCHY        繼承體系圖

使用Doxygen生成C#幫助文檔

配置好後中進入Run頁籤單擊 Run Doxygen 即開始生成,等待生成完畢後點選 “Show HTML output”

使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔
使用Doxygen生成C#幫助文檔

提醒一下,如果是WIN8的作業系統,建議設定dot的相容性,并以管理者身份運作,否則一直會彈出dot停止運作的警告框

使用Doxygen生成C#幫助文檔

本文轉自趙青青部落格園部落格,原文連結:http://www.cnblogs.com/zhaoqingqing/p/3842236.html,如需轉載請自行聯系原作者