寫文檔是一件非常冗雜的事情有些機(jī)構(gòu)聘請(qǐng)一個(gè)或多個(gè)專.ppt

Doxygen簡(jiǎn)介,馬秋梅05/06/15,Doxygen的來歷,寫文檔是一件非常冗雜的事情。有些機(jī)構(gòu)聘請(qǐng)一個(gè)或多個(gè)專門人員來處理整個(gè)工作描述文檔。一個(gè)Java開發(fā)者突發(fā)奇想，“如果我們?cè)O(shè)計(jì)一個(gè)可以根據(jù)我們的源文件注釋來產(chǎn)生文檔的工具，那會(huì)怎樣呢？”，于是JavaDoc就誕生了。那么C+編程者怎么辦？還要繼續(xù)進(jìn)行這種冗雜的工作嗎？這時(shí)候Doxygen的出現(xiàn)解決了這個(gè)難題。,Doxygen是什么？,Doxygen的詞根來源于Document（文檔）和Oxygen（氧氣），是一種適合C風(fēng)格語言（如C+、C、IDL、Java甚至包括C#和PHP）的、跨平臺(tái)的、開放源碼的、基于命令行的代碼文檔產(chǎn)生器。Doxygen由荷蘭人DimitrivanHeesch.開發(fā)，并且在GNU公共許可證（GPL）下發(fā)布，目前已經(jīng)成為各主要的Linux發(fā)行版的附帶組件。眾多重量級(jí)的軟件項(xiàng)目（如KDE，Qt、ACE庫(kù)等）都選用Doxygen作為其編檔工具生成項(xiàng)目文檔。,Doxygen可以做什么？,一、可以從一套文檔化的源代碼中，生成一份可在線瀏覽的文檔(HTML格式)或離線參考手冊(cè)(LATEX格式)。還可以生成RTF(MS-Word)、PS、PDF以及Unixmanpages等格式的文檔。二、可以從沒有文檔化的源代碼中抽取代碼結(jié)構(gòu)。這一點(diǎn)對(duì)于快速理清大型的源代碼包的脈絡(luò)很有幫助。還可以通過自動(dòng)生成的依賴圖，繼承圖，協(xié)作圖來將不同元素之間的關(guān)系可視化（分析他人的代碼（沒有注釋或者注釋很糟糕）來得到原作者的設(shè)計(jì)思路、實(shí)現(xiàn)方法，這樣自己就可以根據(jù)需要進(jìn)行相應(yīng)的修改。）。三、可以“濫用”doxygen來創(chuàng)建普通的文檔（殺雞使用宰牛刀了）。,Doxygen工作流程圖,Doxygen使用了一個(gè)基于文本的配置文件，你可以在配置文件中設(shè)定大量的選項(xiàng)來控制Doxygen的行為。配置文件的格式與一般的配置文件相似，是由名稱/值對(duì)組成的ASCII碼，由doxygen命令來解析。有兩種方式可以創(chuàng)建和修改配置文件：1、Doxygen可以在命令行方式下加上參數(shù)-g自動(dòng)創(chuàng)建模板文件，然后你就可以修改這個(gè)配置文件。2、也可以使用Doxygen提供的輔助工具Doxywizard。Doxywizard是Doxygen的GUI前臺(tái)，用戶可以通過它來讀寫配置文件，省卻了手工配置的麻煩。,如何使用Doxygen？,如何生成Doxygen配置文件？(一),doxygeng忽略將會(huì)生成一個(gè)名為Doxyfile的缺省文件，如果已經(jīng)存在，會(huì)被Doxygen改名為.bak。jedDoxyfile編輯這個(gè)模板文件，使之符合你的需求。,需要特別注意的選項(xiàng)：,PROJECT_NAME=CalibROOTPROJECT_NUMBER=1.0.0OUTPUT_DIRECTORY=/home/maqm/htmlINPUT=/s01/maqm/boss-05-06-06/CalibrationCLASS_GRAPH=YES（會(huì)為每個(gè)歸檔的類創(chuàng)建一張圖表示其直接或間接的繼承關(guān)系。）INCLUDE_GRAPH=YES(為每個(gè)歸檔文件創(chuàng)建一幅包含依賴圖）COLLABORATION_GRAPH=YES（會(huì)為每個(gè)歸檔類或結(jié)構(gòu)繪制基類繼承關(guān)系圖和使用關(guān)系圖）CALL_GRAPH=YES（會(huì)為每個(gè)函數(shù)顯示一幅直接或間接調(diào)用關(guān)系圖）GRAPHICAL_HIERARCHY=YES（將會(huì)繪制一個(gè)圖形表示的類圖結(jié)構(gòu)）,SOURCE_BROWSER=YESSHOW_INCLUDE_FILES=YESFILE_PATTERNS=*.cxx*.hRECURSIVE=YESALPHABETICAL_INDEX=YESGENERATE_HTML=YESGENERATE_LATEX=YESPDF_HYPERLINKS=NOEtc.,如何生成Doxygen配置文件？(二)doxywizard,如何生成需要的文檔？,doxygenDoxyfile生成