使用doxygen生成chm幫助詳解

CopyRight?2010AllWinnerTech,All 1Doxygen

oxygen是一個(gè)用來解析源碼包和生成 支持CCJava, CopyRight?2010AllWinnerTech,All 1Doxygen

CopyRight?2010AllWinnerTech,All 1Doxygenoxygen靈活的注釋布局，允許你在頭件（ 之），源文件（定義之前）是個(gè)獨(dú)文。 CopyRight?2010AllWinnerTech,All 1Doxygenoxygen特點(diǎn)（續(xù) 使用微軟的HTMLHelpWorkshop工具可從HTML輸出 CopyRight?2010AllWinnerTech,All

CopyRight?2010AllWinnerTech,All doxywizard圖形窗口和一個(gè)Examplefolder示例使用HTMLHelpWorkshop中的 擎（單個(gè)文件易于

CopyRight?2010AllWinnerTech,All 2.2Doxygen

oxygen使用一個(gè)配置文件來包含它的所有 中使用“doxygen–g<config-file>”，如果忽略文件TAGNAME=TAGNAME=VALUE1 CopyRight?2010AllWinnerTech,All 2.3DoxywizardDoxywizard主窗

CopyRight?2010AllWinnerTech,All ①向?qū)?Wizard)模式：將快速配置大多數(shù)重要的設(shè)②專家(Expert) CopyRight?2010AllWinnerTech,All 2.3DoxywizardDoxywizard向?qū)?/p>

CopyRight?2010AllWinnerTech,All 2.3DoxywizardMode相關(guān)選項(xiàng)（查找源碼方式

CopyRight?2010AllWinnerTech,All 2.3Doxywizard

CopyRight?2010AllWinnerTech,All 2.3Doxywizard

CopyRight?2010AllWinnerTech,All 2.3DoxywizardDoxywizard專家框

CopyRight?2010AllWinnerTech,All 2.3Doxywizard

Doxywizard專家 框（續(xù)該框包含一定數(shù)量的選項(xiàng)卡，每個(gè)選選項(xiàng)更改后變成紅色，鼠標(biāo)可恢 CopyRight?2010AllWinnerTech,All 2.3Doxywizardoxygen運(yùn)行 CopyRight?2010AllWinnerTech,All 遵從doxygen注釋規(guī)范進(jìn)行注釋的代碼

*...text CopyRight?2010AllWinnerTech,All intvar;*!<…text…*/或intvar;/**<…text…*/或intvar;//!<…text…或intvar;///<如：voidfoo（intv/**<[in] CopyRight?2010AllWinnerTech,All

CopyRight?2010AllWinnerTech,All oxygen文檔內(nèi)容可用\mainpage和\page命令合并 CopyRight?2010AllWinnerTech,All

\defgroupgroup1TheFirstThisisthefirst\ingroup\brieffunction1ingroupvoidfunction1 CopyRight?2010AllWinnerTech,All

/*!/*!\addtogroup ationforthefirst/*!anotherfunctioningroup1voidfunc2()/*!yetanotherfunctioningroup1*/voidfunc3(){}/*!@}*///endof CopyRight?2010AllWinnerTech,All

@nameDescriptionofgroup/*!Function1ingroup1.Details.*/voidTest::func1InGroup1(){}/*!Function1ingroup2.Details.*/voidTest::func2InGroup1(){}/*@} CopyRight?2010AllWinnerTech,All

/*!/*!\mainpageAsimlpesomegeneral-\subpagepage1-\subpagepage2Advanced*\pagepage1 ationpage/*!\pagepage2Evenmore CopyRight?2010AllWinnerTech,All ①只在HTML②類文檔中能生成繼承圖，它能顯示直接和間接的繼③文件的文檔中能生成依賴包容圖，文件至少要包含④如果CALL_GRAPH設(shè)置為YES，將為每個(gè)函數(shù)繪 CopyRight?2010AllWinnerTech,All 當(dāng)使用doxygen時(shí)，它會(huì)自動(dòng)解析輸

CopyRight?2010AllWinnerTech,All 3.3

在注釋中所有 CopyRight?2010AllWinnerTech,All 3.3

(PHPonly)

(PHP

(PHP CopyRight?2010AllWinnerTech,All

3.3注釋中至少有一行以下內(nèi)容：/*!\file*/

CopyRight?2010AllWinnerTech,All 3.3

\file[file\brief{brief\author{listof\date{date\version{version\note*\warning{warning*\detailsdetailed CopyRight?2010AllWinnerTech,All 3.3\param<parameter-name>{parameterdescription\return{descriptionofthereturnvalue\retval<returnvalue>{description\remark{remark\sa\since

CopyRight?2010AllWinnerTech,All 3.3\fn(function注釋塊未被放置到函數(shù)或定義的前面或后

CopyRight?2010AllWinnerTech,All 3.3

\briefAmember\paramca\paramnan\returnacharacter\remarksmore\since\safunc3(charc,int CopyRight?2010AllWinnerTech,All 3.3intvarintvar;/*!<descriptionafterthemember*/intvar;///<Briefdescriptionafterthemember

/*!\briefoneenum,withinlinedocs*//*!\briefoneenum,withinlinedocs*/enumOneEnum{V1;/**<value1*/V2;/**<value2*/ CopyRight?2010AllWinnerTech,All 3.3代碼塊使用命令/*!/*!\par示例代碼externint\par[paragraphtitle]{paragraph\section<section-name>(section\subsection<subsection-name>(subsection

CopyRight?2010AllWinnerTech,All 3.3

/*!/*!Unconditionally\ifOnlyincludedifCond1is\ifOnlyincludedifCond2is\ifOnlyincludedifCond2andCond3areMoreUnconditional CopyRight?2010AllWinnerTech,All 3.3\cond [<section-b]“\cd”EALD_SCTIN

/*!Aninterface/*!Aninterface*/classIntf{/*!Amethodvirtualvoidfunc()=///\cond/**Amethodusedfortesting*/virtualvoidtest()=0;/// CopyRight?2010AllWinnerTech,All 3.3\arg{item-description與\li命令作用相同。該命\arg\arg\cAlignLeftleft\arg\cAlignCentercenter\arg\cAlignRightrightNoothertypesofalignmentare\li{item-description}生成列表,與\arg

CopyRight?2010AllWinnerTech,All 3.3\attention{attention\bug{bug\def\image<format><file>[“caption”]

\image\imagehtmlapp.jpg“my CopyRight?2010AllWinnerTech,All 3.3Link<link- AAlinktoafile\link#fun1usinganotherfn\endlink\mainpage\subpage<name>

CopyRight?2010AllWinnerTech,All 3.3\todo{paragraphdescribingwhatistobedone}\ref<name>\see表示交

CopyRight?2010AllWinnerTech,All 3.3視覺增 \a\b\c\e

CopyRight?2010AllWinnerTech,All 3.4

CopyRight?2010AllWinnerTech,All 3.4 這樣做會(huì)帶來不必要的注釋工作。

CopyRight?2010AllWinnerTech,All 4Doxywizard BRIEF_MEMBER_DESC使用默認(rèn)值（YES），doxygen將 CopyRight?2010AllWinnerTech,All 4

CopyRight?2010AllWinnerTech,All 4 \bug命令來創(chuàng)建bug

CopyRight?2010AllWinnerTech,All 4WARNINGS用于打開或關(guān)閉doxygen生成錯(cuò)誤記錄時(shí)的警告消息，若設(shè)定YES表明打開警告消息。技巧：當(dāng)寫文檔時(shí)應(yīng)打開警告消息。 若設(shè)為YES，doxygen將WARN_FORMAT確定doxygen所生成警告消息的格式，消息字串會(huì)包含$file,$line,$text標(biāo)記，并且這些標(biāo)記將WARN_LOGFILE用于指定一個(gè)警告和錯(cuò)誤消息寫入的日

CopyRight?2010AllWinnerTech,All 4 myfile.cpp文件名或/usr/src/myproject FILE_PATTERNS如果INPUT包含有 一個(gè)或多個(gè)通配符（如*.cpp和*.h） 當(dāng)設(shè)定為YES時(shí)，INPUT所指定 CopyRight?2010AllWinnerTech,All 4

CopyRight?2010AllWinnerTech,All 4與SourceBrowser CopyRight?2010AllWinnerTech,All 4

與SourceBrowser CopyRight?2010AllWinnerTech,All 4GENERATE_HTML若為YES(默認(rèn))，doxygen將生成HTML 指定生成的HTML頁面文件的擴(kuò)HTML_HEADER要使用在每一頁HTML文件中的Header。如果沒有指定，Doxygen會(huì)使用自己預(yù)設(shè)的Header。HTML_FOOTER要使用在每一頁HTML文件中的Footer。如果沒有指定，Doxygen會(huì)使用自己預(yù)設(shè)的Footer。HTML_STYLESHEET您可給定一個(gè)CSS的設(shè)定，讓HTMLGENERATE_HTMLHELP如設(shè)定為YES，Doxygen會(huì)產(chǎn)生一個(gè)索引檔。這個(gè)索引檔在您需要制作windows上的HTML格 CopyRight?2010AllWinnerTech,All 4

CopyRight?2010AllWinnerTech,All 4

若GENERATE_HTMLHELP為YES于指定 若GENERATE_HTMLHELP為YES記用于指定HTML幫助文件編譯器hhc.exe_INDEX_ENCODING用于指