doxygen 中文手冊(cè)是專門為開發(fā)人員整理編寫而成的一本如何使用doxygen軟件的手冊(cè),Doxygen是一個(gè)程序的文件產(chǎn)生工具,可將程序中的特定批注轉(zhuǎn)換成為說(shuō)明文件。Doxygen就是在您寫批注時(shí),稍微按照一些它所制訂的規(guī)則。軟件的使用可分為兩大部分。首先是特定格式的批注撰寫,第二便是利用軟件的工具來(lái)產(chǎn)生文件。有了小編提供的這本doxygen 中文手冊(cè),能夠更輕松的學(xué)習(xí)如何使用這款軟件,如果用戶想要更好的使用這款強(qiáng)大的幫助文檔生成器輕松生成各種開發(fā)文檔的幫助文件,歡迎有需要的朋友前來(lái)下載參考!
doxygen工具介紹編輯
Doxygen 是一個(gè)程序的文件產(chǎn)生工具,可將程序中的特定批注轉(zhuǎn)換成為說(shuō)明文件。通常我們?cè)趯懗绦驎r(shí),或多或少都會(huì)寫上批注,但是對(duì)于其它人而言,要直接探索程序里的批注,與打撈泰坦尼克號(hào)同樣的辛苦。大部分有用的批注都是屬于針對(duì)函數(shù)、類型等等的說(shuō)明。所以,如果能依據(jù)程序本身的結(jié)構(gòu),將批注經(jīng)過(guò)處理重新整理成為一個(gè)純粹的參考手冊(cè),對(duì)于后面利用您的程序代碼的人而言將會(huì)減少許多的負(fù)擔(dān)。不過(guò),反過(guò)來(lái)說(shuō),整理文件的工作對(duì)于您來(lái)說(shuō),就是沉重的負(fù)擔(dān)。
對(duì)于未歸檔的源文件,也可以通過(guò)配置Doxygen來(lái)提取代碼結(jié)構(gòu)?;蛘呓柚詣?dòng)生成的包含依賴圖(includedependency graphs)、繼承圖(inheritance diagram)以及協(xié)作圖(collaborationdiagram)來(lái)可視化文檔之間的關(guān)系。Doxygen生成的幫助文檔的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。
一個(gè)好的程序設(shè)計(jì)師,在寫程序時(shí),都會(huì)在適當(dāng)?shù)牡胤郊由虾线m的批注。如果,能夠在撰寫批注時(shí),稍微符合某種格式,接著就可以透過(guò)一個(gè)工具程序依據(jù)程序結(jié)構(gòu)及您的批注產(chǎn)生出漂亮的文件。這將令許多工作繁重的程序設(shè)計(jì)師有時(shí)間多喝幾杯咖啡。
Doxygen 就是這樣的一個(gè)工具。在您寫批注時(shí),稍微按照一些它所制訂的規(guī)則。接著,他就可以幫您產(chǎn)生出漂亮的文件了。因此,Doxygen 的使用可分為兩大部分。首先是特定格式的批注撰寫,第二便是利用Doxygen的工具來(lái)產(chǎn)生文件。
0條評(píng)論