一、前言

以前，我們學C語言的時候，多多少少都查過一些標準庫函數吧。這裡介紹查找C語言的標準庫函數的兩種方法：一種方法是直接到http://www.cplusplus.com這個網站上去查看：

這裡覆蓋了C語言標準庫中的所有函數，給出了每個函數的介紹並且都給出了具體的用法示例，比如：

只不過都是英文的說明，可見英文的重要性。

另一種方法是，找一些離線的文檔，網上有不少人整理了一些離線的文檔，比如.chm格式（已編譯的幫助文件）的文檔：

裡面大概是這樣子的：

也可以很方便的查找每個函數的用法，但是，這裡面的不是很全，所以查找C標準庫函數還是建議到http://www.cplusplus.com上面去查找。

本文分享的重點就是.chm文件的製作。最近需要對自己的一些代碼做一些整理，發現整理成.chm文件是個不錯的選擇，.chm文件可以根據我們的代碼生成，下面把生成.chm文件的方法分享給大家。

二、製作.chm文件的工具

需要三個工具：doxygen安裝包、graphviz安裝包、htmlhelp安裝包。其中doxygen是一種開源跨平臺的文檔系統，doxygen可以從一套歸檔源文件開始，生成HTML格式的在線類瀏覽器，或離線的LATEX、RTF參考手冊。

doxygen可以生成好幾種格式的文檔，要生成.chm格式的手冊就必須安裝htmlhelp，要生成關係圖必須安裝依graphviz。這個個工具的獲取方法：

1、方法一：官網下載

（1）doxygen安裝包：

http://www.doxygen.nl/download.html

（2）graphviz安裝包：

http://www.graphviz.org/

（3）htmlhelp安裝包：

https://www.microsoft.com/en-us/download/details.aspx?id=21138

鏈接：https://pan.baidu.com/s/1gsJxkGsoO0ncy0GGM6PyQw 提取碼：3754

若鏈接失效可聯繫我。

下載的都是.exe格式的可執行文件，就按平時安裝軟件的方法安裝件就可以了。但是，需要記住graphviz與htmlhelp的安裝路徑，後面使用Doxygen時需要用到。

三、Doxygen根據代碼生成.chm的機制

Doxygen可以根據固定格式的代碼註釋生成相對應的.chm格式的手冊。支持的語言有好多種，如C/C++/C#/Objective-C/PHP/Java等。這裡主要是分享C語言，Doxygen可以識別的固定格式註釋有以下幾種：

這裡，我使用第一種，如：

<code>/**
 * 函數功能：字符串逆序函數
 * @param src_str：字符串
 * @param str_len:字符串長度
 * @return 逆序之後得到的字符串
 */ 
char *Str_ReverseOrder(char *src_str,int str_len)
{
\tchar *dst_str = src_str;
\tchar temp;
\tprintf("Method 1!\\n");
\tfor(int i=0;i\t{
\t\ttemp = src_str[i];\t\t\t\t\t
\t\tsrc_str[i] = src_str[str_len-i-1];  
\t\tsrc_str[str_len-i-1] = temp;\t\t
\t}
\t
\treturn (char*)dst_str;
}/<code>

所有的函數都使用這樣統一格式的註釋。

四、Doxygen生成.chm文件的方法

1、設置工程工作目錄

2、設置編程語言

3、設置輸出文件格式

4、設置生成的關係表

5、輸出的語言、編碼

6、設置一些構建的選擇項

7、設置輸入文件的編碼

8、設置是否在.chm中生成源碼以供預覽

9、設置HTML選項

10、設置Dot選項

11、運行生成.chm文件

12、保存工程文件

五、最終成果效果圖

下面看一下我們生成的.chm文件：

閱讀更多 嵌入式大雜燴 的文章

關鍵字: 軟件 C語言 文檔