Doxygen 使用方法
1、第一次使用需要安裝doxygen的程序2、生成doxygen配置文件
3、編碼時,按照某種格式編寫注釋
4、生成對應(yīng)文檔
Doxygen 特別說明
1.doxygen的安裝非常簡單。在linux下,您可以直接下載安裝包并運(yùn)行它。下載源代碼、編譯和安裝也是編譯和安裝的常用命令。2.生成文檔時,可以在文檔生成過程中定義項目屬性和許多選項。您可以使用以下命令生成默認(rèn)配置文件:doxygen-g[配置文件名]
3.配置文件中對應(yīng)的項目可以根據(jù)項目的具體要求進(jìn)行修改,修改后的配置文件可以作為以后項目的模板。
4.讓軟件自動生成文檔,但是平時的標(biāo)注風(fēng)格不行,需要按照自己的格式。
5.好了,代碼寫完了,評論按照格式寫。最后的文件是什么?很簡單,運(yùn)行下面的命令,就會在指定的目錄下生成相應(yīng)的文檔:doxygen[配置文件名]
6.需要注意的是,doxygen并不處理所有的注釋,而是側(cè)重于與程序結(jié)構(gòu)相關(guān)的注釋,比如文件、類、結(jié)構(gòu)、函數(shù)、變量和宏的注釋,而忽略了函數(shù)內(nèi)變量和代碼的注釋。