嵌入式系統開發環境的構建13:安裝Doxygen生成程序註釋文檔

本系列教程將向大家講述,在自己的計算機上構建完善的嵌入式系統開發環境的方法。

本文將向大家講述安裝Doxygen生成程序註釋文檔的方法。

Doxygen簡介:

Doxygen 是一個程序的文件產生工具,可將程序中的特定註釋轉換成爲說明文件。通常我們在寫程序時,或多或少都會寫上註釋,但是對於其它人而言,要直接探索程序裏的註釋,與打撈泰坦尼克號同樣的辛苦。大部分有用的註釋都是屬於針對函數、類型等等的說明。所以,如果能依據程序本身的結構,將註釋經過處理重新整理成爲一個純粹的參考手冊,對於後面利用您的程序代碼的人而言將會減少許多的負擔。不過,反過來說,整理文件的工作對於您來說,就是沉重的負擔。

對於未歸檔的源文件,也可以通過配置Doxygen來提取代碼結構。或者藉助自動生成的包含依賴圖(includedependency graphs)、繼承圖(inheritance diagram)以及協作圖(collaborationdiagram)來可視化文檔之間的關係。Doxygen生成的幫助文檔的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。

一個好的程序設計師,在寫程序時,都會在適當的地方加上合適的註釋。如果,能夠在撰寫註釋時,稍微符合某種格式,接着就可以透過一個工具程序依據程序結構及您的批註產生出漂亮的文件。這將令許多工作繁重的程序設計師有時間多喝幾杯咖啡。

Doxygen 就是這樣的一個工具。在您寫批註時,稍微按照一些它所制訂的規則。接着,他就可以幫您產生出漂亮的文件了。因此,Doxygen 的使用可分爲兩大部分。首先是特定格式的批註撰寫,第二便是利用Doxygen的工具來產生文件。


一、安裝步驟

1、從官網下載:http://www.doxygen.nl/download.html

2、雙擊安裝文件運行,同意許可。

3、更改程序安裝路徑。

4、安裝全部選項。

5、設置“開始菜單”文件夾名稱。

6、確認安裝信息。

7、進行程序安裝。

8、進行信息確認。

9、完成安裝。

二、使用方法

可參看Git服務器上的程序案例的註解使用方法,在後續階段,補充此段內容。

 

 

 

 

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章