doxygen的使用(一)配置並生成文檔

原創文章,歡迎閱讀,禁止轉載。工具

doxygen是個好用的文檔生成工具,他的強大功能有不少介紹,我就不說了。
自帶的chm幫助手冊很全面,包括功能、註釋規範、怎麼配置、工具用法等。

doxygen的用法共3步:
1. 按照註釋規範對代碼加註釋。
2. 配置選項。
3. 生成文檔。

配置選項
能夠使用命令行工具 doxyfen -g 生成一個配置模版,我直接使用帶界面的配置嚮導來配。
嚮導中的三個選項卡:
1. wizard 進行大體的配置選擇
2. expert 進行精細的配置
3. run 生成文檔

配置界面第一步如圖,其餘步驟都很簡單:

配置完之後,在run選項卡中生成便可。

說明
要正確的選擇輸入和輸出等各類編碼。
嚮導中的配置必須保存之後才能生成文檔。

生成chm文檔:
HHC_LOCATION 要填hhc.exe的絕對路徑。
CHM_INDEX_ENCODING 必須是GBK,不然chm左側是亂碼。編碼

原創文章,歡迎閱讀,禁止轉載。spa

相關文章
相關標籤/搜索