doxygen解析支持的標(biāo)簽規(guī)范

1、doxyge n解析支持的標(biāo)簽規(guī)范 目錄1.dox常用命令1.2.3.4.5.6.2.dox文獻信息dox狀態(tài)信息dox模塊信息dox函式信息dox提醒信息dox關(guān)聯(lián)信息dox標(biāo)簽格式3.dox注釋風(fēng)格6. dox常用命令講述基本的常用標(biāo)簽命令6.1. dox文獻信息author .作者brief .摘要file .文件聲明6.2. dox狀態(tài)信息version .版本推薦使用$ld$todo .改進，可以指定針對的版本6.3. dox模塊信息var .模塊變量說明typedef .模塊變量類型說明6.4. dox 函式信息paramp .參數(shù)p說明arg.列表說明參數(shù)信息return .返回

2、值說明retval .返回值類型說明6.5. dox提醒信息n ote.注解attention 、亠注意bug.問題war nin g .警告66 dox關(guān)聯(lián)信息sa. 參考資料7. dox標(biāo)簽格式約定文檔化標(biāo)簽的語法epydoc支持兩種標(biāo)簽的語法！doxyge n:r1 tag1i內(nèi)容.Javadoc:iitag1i內(nèi)容.為了簡化學(xué)習(xí)，在新浪標(biāo)準化開發(fā)中我們推存統(tǒng)一使用1i1:tag:1i內(nèi)容.格式8. dox注釋風(fēng)格約定文檔化標(biāo)簽放置依照C/C+ JAVA類別語言注釋風(fēng)格自然的進行/*個示范類，描述在此*/class Testpublic:/* 一個 enum.* 詳細描述可以多行*/en

3、um TEnum TVall, /*單行注釋*/*enumPtr, /* enum pointer. Details. */構(gòu)造器函式詳細描述可以多行一個普通函式描述和參數(shù)等等的敘述/*/Test();/* param a整數(shù)參數(shù)* param s字串指針參數(shù)* see Test()參看.* return返回值描述*/int testMe(i nt a,c onst char *s);/*純虛成員函式* see testMe()參看param c1第一參數(shù)* param c2第二參數(shù)*/*virtual void testMeToo(char c1,char c2) = 0;一個公共變量詳細描

4、述*/int publicVar;；DoxyGen支持多種注釋聲明,僅僅是在標(biāo)準基礎(chǔ)上添加一點兒JavaDoc樣式的：/* * . text .*/Qt樣式的:/*!. text .*/oC+樣式的：11111/III. text .:/i1or/! 1/! . text ./!io我們推薦簡化的Qt風(fēng)格io to r o o/*!引發(fā)的多行注釋|.i*/!o正常結(jié)束!o塊結(jié)構(gòu)象文章分章節(jié)一樣注釋文本也能定義各種語義區(qū)塊12.1. 段落par命令引出/*! class Test普通文字par用戶定義第一段.段落可以包含多行par這是第二段.段落間通過空行來區(qū)分*/*具體實例參考：opar命令o

5、輸出的HTML12.2. 列表li命令引發(fā)可以混合其它格式命令-li c Alig nLeft left alig nment.li c Alig nCen ter cen ter alig nment.li c Alig nRight right alig nment無類型的列表項也支持* 具體實例參考：oli命令12.3. 章節(jié)* section命令引發(fā)* 不過，只能在 page命令后作用即通過 page命令，聲明創(chuàng)建一個相關(guān)頁面，內(nèi)容將組織到最終的相關(guān)頁面”中,與Todo Bug列表頁面等等并列在一起 ！例如/*! page pagel A docume ntati on pageLea

6、di ng text.secti on sec An example secti onThis page contains the subsectionsref subsection1and ref subsecti on2.For more info see page ref page2.subsecti on subsecti on1 The first subsecti on Text.subsecti on subsecti on2 The sec ond subsecti on More text.*/*! page page2 Ano ther page Eve n more in

7、fo.*/*將生成：opage命令o包含了section 章subsection 節(jié)ref提及三個命令的使用1類似：1! o i。! o1/*!1.ipar _doAl IOn Load()1o1param 全局數(shù)組 g_onload!code和 endcode框出i o I12.4. 引用塊return void 逐條調(diào)用已知的函數(shù)A_AiiiIoIII:oIIII note動態(tài)加載的模塊中，一些函數(shù)需要onLoad()事件觸發(fā)；但是| ocode window.onload= new Function(myFu nctoi n(););oen dcodeoI o將會重新注冊onLoad()

8、事件的運行函數(shù),致使不能簡單的使不同的Ii模塊中需要的不確定數(shù)目的onLoad() 觸發(fā)函數(shù)疊加注冊！IIo.o*/II.o13. 行內(nèi)修飾* 簡單的字體聲明13.1. b b文字 生成：o文字 13.2. c* c文字 生成：o 文字 13.3. n n* 生成：o13.4. 特殊標(biāo)簽針對PHP語言，doxygen有幾個標(biāo)簽命令，需要關(guān)注13.4.1. PHP代碼說明專用private私有的protected 保護的 public公開的 是獨立說明項的聲明標(biāo)簽 用以說明 類/函式/變量 的具體性質(zhì)13.4.2. PHP章節(jié)內(nèi)容專用* privatesecti on 私有的章節(jié)* protectedsec