歡迎來到Linux教程網
Linux教程網
Linux教程網
Linux教程網
您现在的位置: Linux教程網 >> UnixLinux >  >> Linux編程 >> Linux編程

用doxys生成C++文檔

寫C++代碼,寫注釋,然後自動生成文檔,這是任何一個規范的C++開發流程都必須的。今天試了一下doxys,挺好用的。

在Ubuntu機器上,先下載Linux版的doxys程序,網址在:http://www.doxys.dk/doxys_homepage/homepage/Download/Download0_dir_description.html

解壓

tar jxvf doxys_1_15_linux32_bin.tar.bz2

然後進入該目錄,用root權限運行

./install_RunAsRoot.sh

安裝完成。

現在進入C++項目目錄,在頂層目錄就好。然後運行doxys,會自動掃描目錄結構,提取comments,生成html文檔。所有的文檔都會創建在doxys_docs目錄下。

最後,doxys要求的comments書寫格式有點特別,參考這裡:http://www.doxys.dk/doxys_homepage/homepage/Documentation/Example_Code/HowToDocument0_class_description.html

和我用的Google c++ style的要求// 不一樣。在找到能夠提取google c++ style的comments之前,先委屈一下,就用///吧。

或者采用Java風格:

/**

*/

現在看一下生成的文檔中包含的類繼承關系圖,還是不錯的吧。

注釋中如何描述參數和返回類型,我選擇了Java風格。參考文檔:

http://www.doxys.dk/doxys_homepage/homepage/Documentation/Example_Code/ParametersJavaStyle4173613626_member_description.html

Copyright © Linux教程網 All Rights Reserved