青青草原综合久久大伊人导航_色综合久久天天综合_日日噜噜夜夜狠狠久久丁香五月_热久久这里只有精品

Benjamin

靜以修身,儉以養(yǎng)德,非澹薄無以明志,非寧靜無以致遠(yuǎn)。
隨筆 - 398, 文章 - 0, 評論 - 196, 引用 - 0
數(shù)據(jù)加載中……

編寫C++幫助文檔的工具-----doxys使用方法

doxys是開源軟件,  文章最后給的鏈接里的doxys.exe是debug版本,還有個配置文件,感興趣的朋友可以打開鏈接下載,按照下面的方法使用即可。
一、更改配置
:打開DoxySfile,設(shè)置INPUT(源碼路徑)、OUTPUT_DIRECTORY(輸出路徑)、OUTPUT_LANGUAGE(語言選擇----界面語言)

如果是中文界面,只要改變INPUTOUT_DIRECTORY的路徑就可以。

 

二、生成文檔:進(jìn)入MS-DOS,切換到doxys.exe所在的路徑,執(zhí)行doxys DoxySfile -m就可產(chǎn)生幫助文檔,不過都是html。

 

三、制作CHM文檔:進(jìn)入到配置文件中的OUTPUT_DIRECTORY(輸出路徑)下,在common目錄,打開js.js,搜索一下“http://www.doxys.dk,

將有這已經(jīng)的代碼行注釋掉(這行在頁面上產(chǎn)生“產(chǎn)生 DoxyS”鏈接,它的直接結(jié)果就是產(chǎn)生doxys的英文幫助)。

最后單擊.hhc.hhk.hhp文件,File菜單下點擊“compile”,就可以產(chǎn)生.chm文件。

 

四、其他:必須的安裝文件還有htmhtlp.exe.

 

 

附錄:編寫注釋規(guī)范

一、函數(shù)注釋:

/**

\brief

簡短注釋

\n

* @param[in] 輸入?yún)?shù)

* @param[out] 輸出參數(shù)

* @return 返回值

* @note 注解

* @par 示例

* @code 代碼

* @endcode

* @see 參見

* @deprecated 相關(guān)信息

也可以在@param后面直接跟參數(shù)

 

示例:函數(shù)OpenFile的注釋

    /**

    \brief file_文件

    打開文件 \n

    文件打開成功后,必須使用 ::CloseFile 函數(shù)關(guān)閉。

    * @param[in] file_name 文件名字符串

    * @param[in] file_mode 文件打開模式字符串,可以由以下幾個模塊組合而成:

    * - r 讀取

    * - w 可寫

    * - a 添加

    * - t 文本模式(不能與 b 聯(lián)用)

    * - b 二進(jìn)制模式(不能與 t 聯(lián)用)

    * @return 返回文件編號

    * - -1 表示打開文件失敗

   

     * @note 文件打開成功后,必須使用 ::CloseFile 函數(shù)關(guān)閉

     * @par 示例:

     * @code

     // 用文本只讀方式打開文件

     int f = OpenFile("d:\\test.txt", "rt");

     * @endcode

     

        * @see ::ReadFile ::WriteFile ::CloseFile

        * @deprecated 由于特殊的原因,這個函數(shù)可能會在將來的版本中取消。

    */

int OpenFile(const char* file_name, const char* file_mode);

二、變量注釋:

/** 成員變量描述 */

 int m_Var;

三、宏定義注釋:

/** 定義說明 */

#define LOG_FILENAME "d:\\log\\debug.log"

 

在宏定義中我們也可以分組展示:就是在一組的宏定義前面和后面分別加注釋

前面加:

/** @name 文件名常量

 * @{

 */

后面加:

/** @}*/ // 文件名常量

如下所示:

/** @name 文件名常量

 * @{

 */

 

/** 日志文件名 */

#define LOG_FILENAME "d:\\log\\debug.log"

/** 數(shù)據(jù)文件名 */

#define DATA_FILENAME "d:\\data\\detail.dat"

/** 存檔文件名 */

#define BAK_FILENAME "d:\\data\\backup.dat"

 

/** @}*/ // 文件名常量

 

四、枚舉注釋:

/** 枚舉常量 */

typedef enum TDayOfWeek

{

    SUN = 0, /**< 星期天 */

    MON = 1, /**< 星期一 */

    TUE = 2, /**< 星期二 */

    WED = 3, /**< 星期三 */

    THU = 4, /**< 星期四 */

    FRI = 5, /**< 星期五 */

    SAT = 6 /**< 星期六 */

}

五、類注釋:

1、類的簡短說明:放到類聲明(Yourclass.h)最前面

/*!\file

\brief Yourclass類封裝了對象的屬性及對屬性的操作

*/

.......

.......

class Yourclass{

.........

};

2、類的詳細(xì)說明:在類簡短說明下面

 

/** \file

\brief 每個CPerson類對象包含問題規(guī)定的對象屬性

 

* @author 作者

* @version 版本號

* @date 日期

 

在“誰養(yǎng)魚”問題中,每個對象包含屬性:國籍、顏色、寵物、飲料、香煙、房間號。不過CPerson并不關(guān)心屬性的含義。

屬性對CPerson來說只是序號和值。

*/

六、結(jié)構(gòu)體/聯(lián)合體:

/** A test class. 結(jié)構(gòu)體簡要說明. */

typedef struct TWeek

{

    int a; //!< 星期天

    int b;//!<星期一

    int c; //!<星期二

};


下面的鏈接是doxys.exe、DoxySfile和htmlhelp.exe,doxys.exe是debug版本的比較大,DoxySfile是配置文件,如果搭建懶得寫,改改這個示例的配置文件就行,方法如上所示。
http://www.vdisk.cn/down/index/4361526A7291

Doxygen相關(guān)設(shè)置

首先在“Wizard”標(biāo)簽的Project項進(jìn)行如下設(shè)置:

  • 項目名稱:將在最新的文檔首頁中顯示
  • 源碼列表:選擇要生成文檔的源代碼或目錄,可以有多個文件或目錄形成一個列表。建議使用相對路徑,相對于當(dāng)前目錄(也即當(dāng)前配置文件所在的目錄)
  • 遞歸掃描:如果需要對整個源碼目錄下的所有子目錄及文件生成文檔,請勾選本項
  • 輸出目錄:設(shè)置最終生成的幫助文檔的存儲路徑,建議使用相對路徑

下一步,Mode項,根據(jù)需要設(shè)置文檔生成模式。

下一步,Output項,設(shè)置輸出格式,勾選HTML和“prepare for compressed HTML(.chm)”

然后切換到“Expert”標(biāo)簽的“HTML”項,設(shè)置HTML和CHM相關(guān)的選項:

  • GENERATE_HTMLHELP:確保已經(jīng)勾選了
  • CHM_FILE:最終生成的.chm的文件名,如“HkcProjectHelp.chm”。默認(rèn)為“index.chm”??梢允褂寐窂?,也可以使用相對路徑,相對于上面設(shè)置的輸出目錄的html目錄(建設(shè)使用上一級目錄,如“..\MyDoc.chm”)
  • HHC_LOCATION:chm 編譯器(hhc.exe)的全路徑。請指到 HTML Help Workshop 的安裝目錄的 hhc.exe 程序
  • CHM_INDEX_ENCODING:chm索引文件編碼,下面會講到,這里填“GBK”

編碼設(shè)置

編碼設(shè)置很重要,如果設(shè)置不當(dāng),生成的文檔會出現(xiàn)亂碼。因為 Doxygen 汲及的東西多,有好幾項編碼設(shè)置,所以需要認(rèn)真對待,根據(jù)項目的實情情況設(shè)置。

所有高級設(shè)置(包括編碼設(shè)置)都在“Expert”標(biāo)簽,重要的設(shè)置項如下:

  • Project/DOXYFILE_ENCODING:當(dāng)前 Doxygen 配置文件本身的字符編碼,默認(rèn)為UTF-8,一般不需要修改
  • Project/OUTPUT_LANGUAGE:輸出語言。這里是指Doxygen自己生成的導(dǎo)航、提示、幫助等文本的文字采用的語言。我們希望幫助文檔是全中文的,所以選擇Chinese
  • Input/INPUT_ENCODING:輸入文件的編碼。這里是指我們的源代碼文件本身的編碼。在Windows平臺一般是系統(tǒng)編碼(GBK),而Linux平臺一般是UTF-8。請用文本編輯器查看源文件的編碼。這里如果設(shè)置的不一致,源碼文件的注釋中所有非ASCII字符將在生成的文檔中變成亂碼。
  • HTMP/CHM_INDEX_ENCODING:這里設(shè)置Doxygen生成的CHM索引文件的編碼,以前是不能設(shè)置的,默認(rèn)為UTF-8,而微軟的編譯器不能識別UTF-8編碼的索引文件,所以最終造成左邊目錄導(dǎo)航欄亂碼。我們設(shè)置它為GBK,這樣Doxygen將為我們生成GBK編碼的索引文件(.hhc、.hhk、.hhp)





posted on 2010-04-25 22:04 Benjamin 閱讀(1295) 評論(0)  編輯 收藏 引用 所屬分類: 雜談

青青草原综合久久大伊人导航_色综合久久天天综合_日日噜噜夜夜狠狠久久丁香五月_热久久这里只有精品
  • <ins id="pjuwb"></ins>
    <blockquote id="pjuwb"><pre id="pjuwb"></pre></blockquote>
    <noscript id="pjuwb"></noscript>
          <sup id="pjuwb"><pre id="pjuwb"></pre></sup>
            <dd id="pjuwb"></dd>
            <abbr id="pjuwb"></abbr>
            亚洲黄色一区| 亚洲精品日韩欧美| 久久嫩草精品久久久精品一| 午夜精品久久久久久| 亚洲肉体裸体xxxx137| 亚洲国产精品久久久久婷婷884| 狠狠久久亚洲欧美| 在线欧美电影| 一区二区精品国产| 欧美一区二区三区日韩视频| 亚洲一级免费视频| 久久av一区二区三区漫画| 久久国产毛片| 欧美激情一区二区三区高清视频| 免费亚洲网站| 亚洲欧洲精品天堂一级| 亚洲美女av网站| 午夜视频久久久| 牛牛影视久久网| 欧美日韩情趣电影| 国产一区二区黄色| 一本色道久久综合精品竹菊 | 日韩香蕉视频| 午夜亚洲激情| 欧美激情精品久久久六区热门| 久久国产黑丝| 久久久午夜视频| 欧美午夜精品久久久久久久| 国产精品国产三级国产普通话99 | 欧美淫片网站| 欧美激情欧美激情在线五月| 欧美精品一区二区在线播放| 欧美日韩亚洲网| 亚洲国产精品999| 久久精品天堂| 亚洲一区二区三区在线播放| 欧美一区二区三区视频免费| 久久人人超碰| 国产日韩av高清| 在线一区二区三区做爰视频网站 | 亚洲国内精品在线| 亚洲一区国产一区| 欧美人与禽猛交乱配视频| 国产欧美精品一区二区三区介绍| 亚洲电影毛片| 久久手机精品视频| 翔田千里一区二区| 国产精品永久| 亚洲免费在线观看视频| 欧美激情国产日韩| 久久亚洲综合色| 国产一区91| 欧美在线播放| 亚洲欧美中文字幕| 国产精品免费观看在线| 一本大道久久a久久综合婷婷 | 久久久欧美一区二区| 一区二区三区免费网站| 欧美久久精品午夜青青大伊人| 国外精品视频| 卡通动漫国产精品| 久久国产精品99国产精| 国产欧美精品日韩区二区麻豆天美| 中文在线不卡| 在线亚洲观看| 国产精品一区二区在线观看网站 | 欧美日韩成人在线观看| 91久久精品国产91性色| 老**午夜毛片一区二区三区| 中文亚洲免费| 国产日韩一区二区三区在线播放| 亚洲免费小视频| 亚洲欧美日韩国产综合在线| 欧美日韩一区二区免费视频| 亚洲福利久久| 亚洲精品久久嫩草网站秘色| 裸体歌舞表演一区二区| 亚洲激情视频在线| 亚洲人成小说网站色在线| 欧美伦理91i| 亚洲欧美日韩国产精品| 久久国产精品久久久久久电车| 99热精品在线| 国产精品一区在线观看| 久久久久久成人| 老司机午夜精品视频| 亚洲精选中文字幕| 这里是久久伊人| 黄色av日韩| 亚洲精品综合精品自拍| 国产精品美女999| 久久综合九九| 欧美日韩午夜视频在线观看| 一本久久青青| 久久高清福利视频| 中文在线不卡| 久久亚洲影院| 欧美亚洲视频在线观看| 久久精品99国产精品| 在线欧美一区| 亚洲伊人观看| 亚洲美女精品久久| 欧美夜福利tv在线| 一区二区av在线| 久久米奇亚洲| 欧美一区激情| 欧美视频在线观看| 欧美国产视频在线观看| 国产精品久99| 亚洲人成7777| 亚洲国产精品成人精品| 亚洲综合色自拍一区| 亚洲人成在线观看网站高清| 亚洲精品午夜| 91久久国产精品91久久性色| 日韩视频中午一区| 最新国产成人av网站网址麻豆| 亚洲网站在线观看| 一区二区三区四区五区视频| 欧美亚洲一区二区三区| 一区二区三区精密机械公司 | 亚洲七七久久综合桃花剧情介绍| 99re6热在线精品视频播放速度| 国产一区久久| 亚洲午夜一区二区| 一区二区国产日产| 欧美好骚综合网| 亚洲国产成人av好男人在线观看| 国产欧美一区二区精品性| 亚洲人成在线免费观看| 精品成人一区| 久久免费视频网| 久久久久国产一区二区三区四区| 欧美日韩一区二区三区高清| 久久精品人人爽| 国产亚洲精品v| 欧美伊人精品成人久久综合97| 亚洲一区二区在线| 欧美丝袜第一区| 亚洲一区二区三区免费在线观看| 99精品免费视频| 欧美日韩在线播放三区| 91久久久国产精品| 亚洲另类在线视频| 欧美日韩精品免费观看视一区二区| 久久亚洲国产精品一区二区| 麻豆成人精品| 欧美激情一区在线| 亚洲人成在线观看| 欧美日韩你懂的| 亚洲一级免费视频| 欧美伊人精品成人久久综合97| 欧美小视频在线| 午夜精品久久久久久久99黑人| 亚洲欧美成人网| 国产模特精品视频久久久久 | 亚洲成色最大综合在线| 久久精品国产99精品国产亚洲性色| 久久国产精品久久久久久| 国产精品啊啊啊| 欧美专区在线观看一区| 欧美sm视频| 中文成人激情娱乐网| 国产精品久久77777| 亚洲无毛电影| 牛夜精品久久久久久久99黑人| 亚洲福利视频一区| 欧美日韩三级视频| 欧美中文日韩| 亚洲九九精品| 久久理论片午夜琪琪电影网| 国产一区三区三区| 欧美激情视频一区二区三区不卡| 亚洲精品国产精品国自产在线| 亚洲视频综合| 在线观看日韩av电影| 欧美激情中文字幕乱码免费| 亚洲国产精选| 久久精品一二三区| 一区二区三区欧美激情| 国产日韩一区二区三区在线播放| 久久综合伊人77777尤物| 日韩视频一区二区三区在线播放| 欧美一区二区三区播放老司机| 在线精品视频一区二区三四| 欧美gay视频激情| 欧美专区在线观看| 亚洲已满18点击进入久久| 欧美国产先锋| 老色鬼精品视频在线观看播放| 夜夜嗨av一区二区三区| 黄色一区二区三区| 国产日韩欧美另类| 欧美少妇一区| 欧美大片免费观看| 久久精品综合| 午夜精品视频网站| 一区二区三区三区在线| 亚洲国产精品久久精品怡红院| 欧美自拍偷拍午夜视频|