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

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>
            亚洲一区二区在线免费观看视频| 亚洲女爱视频在线| 欧美成人精品在线| 久久久999精品视频| 久久九九久久九九| 久久综合九色九九| 亚洲高清视频一区| 国产在线观看一区| 国产精品久久久久久久久动漫| 欧美国产精品v| 免费观看成人网| 亚洲高清视频在线| 欧美ab在线视频| 亚洲人成网站777色婷婷| 一区二区欧美在线观看| 亚洲欧美久久久| 久久精品av麻豆的观看方式| 巨乳诱惑日韩免费av| 欧美黄免费看| 国产欧美一区二区三区视频| 亚洲国产天堂网精品网站| 一区二区不卡在线视频 午夜欧美不卡在 | 欧美色欧美亚洲另类二区| 欧美日韩高清在线| 国产精品理论片在线观看| 国产精品视频一区二区三区| 精品电影在线观看| 一区二区三区免费在线观看| 久久久精品日韩| 日韩系列在线| 开元免费观看欧美电视剧网站| 亚洲日韩中文字幕在线播放| 99在线精品视频| 久色成人在线| 国内成+人亚洲| 亚洲欧美日韩精品久久久| 你懂的视频一区二区| 宅男66日本亚洲欧美视频| 麻豆成人综合网| 国产亚洲精品久久久| 亚洲一区日韩在线| 亚洲国产黄色片| 久久久亚洲国产美女国产盗摄| 一本久久a久久精品亚洲| 久久精品一区二区三区中文字幕 | 亚洲精品乱码久久久久久| 亚洲无线视频| 亚洲国产高清视频| 美女脱光内衣内裤视频久久网站| 麻豆乱码国产一区二区三区| 国产伦精品一区二区三区高清| 欧美日韩一区二区在线视频| 韩日欧美一区二区| 久久国产欧美| 欧美伊人久久| 国产尤物精品| 久久亚洲捆绑美女| 欧美影院在线| 国产午夜亚洲精品不卡| 欧美在线免费视屏| 欧美一级欧美一级在线播放| 国产日韩欧美亚洲一区| 久久国产毛片| 久久久久一区二区三区| 国内自拍视频一区二区三区| 久久久亚洲影院你懂的| 欧美资源在线| 在线精品视频在线观看高清 | 亚洲福利视频二区| 午夜精品在线看| 亚洲欧美国内爽妇网| 欧美激情精品久久久久久久变态| 在线播放不卡| 蜜臀av性久久久久蜜臀aⅴ| 久久激情五月丁香伊人| 国产中文一区| 欧美a一区二区| 欧美另类视频| 午夜精品美女久久久久av福利| 美女久久网站| 久久伊人精品天天| 99精品欧美一区二区三区| 99精品国产一区二区青青牛奶| 中日韩视频在线观看| 国产精品久久久999| 久久精品在线免费观看| 另类亚洲自拍| 亚洲一区尤物| 久久久久99精品国产片| 亚洲三级视频在线观看| 亚洲午夜精品久久久久久app| 久久成人精品电影| 亚洲欧洲综合| 亚洲一区二区三区免费视频| 一区二区三区在线观看欧美| 亚洲精品国产精品国产自| 国产伦理一区| 91久久精品www人人做人人爽| 欧美亚洲一区二区在线| 亚洲国产合集| 亚洲字幕一区二区| 在线看成人片| 亚洲欧美日韩综合| 一本色道久久88综合日韩精品 | 狂野欧美一区| 欧美精品激情在线| 欧美在线亚洲综合一区| 欧美精品久久久久久久| 久久精品国产亚洲a| 欧美日韩激情网| 欧美国产日韩二区| 国产精品亚洲产品| 日韩视频免费观看高清完整版| 久久国产精品99久久久久久老狼| 欧美视频网站| 欧美va亚洲va日韩∨a综合色| 久久激情一区| 久久9热精品视频| 欧美区日韩区| 欧美激情第8页| 影音先锋久久精品| 欧美在线亚洲| 久久久精品国产99久久精品芒果| 欧美中文在线字幕| 亚洲一区二区在线看| 欧美乱人伦中文字幕在线| 欧美成人午夜激情在线| 国内久久视频| 欧美一区日韩一区| 亚洲欧美日韩精品久久久久| 国产精品久久久久国产精品日日| 亚洲在线视频免费观看| 欧美精品一区二区三区久久久竹菊 | 久久精品五月婷婷| 亚洲网站在线| 欧美日韩精品一区二区| 欧美成人a视频| 影院欧美亚洲| 卡一卡二国产精品| 亚洲国产91| 亚洲人妖在线| 欧美激情一区三区| 亚洲狼人综合| 亚洲深夜福利视频| 欧美午夜精品| 亚洲欧美日本国产有色| 欧美亚洲专区| 国产在线精品自拍| 久久婷婷丁香| 亚洲精品美女91| 亚洲一级黄色片| 国产人成精品一区二区三| 性色av一区二区三区红粉影视| 国产欧美日韩高清| 亚洲欧美日韩一区在线| 久久精品国产v日韩v亚洲 | 免费成年人欧美视频| 欧美成年人在线观看| 99精品视频免费| 国产精品乱码人人做人人爱| 欧美一区二区三区日韩视频| 裸体一区二区| 99re热精品| 国产精品久久激情| 久久精品国产69国产精品亚洲| 亚洲一区二区视频在线观看| 欧美视频一区二| 久久精视频免费在线久久完整在线看| 日韩视频免费| 欧美日韩精品免费看| 欧美一区二区三区男人的天堂| 亚洲一卡二卡三卡四卡五卡| 国产精品一二一区| 久久一区二区三区超碰国产精品| 午夜精品成人在线视频| 国产综合色精品一区二区三区 | 久久久久久亚洲精品杨幂换脸| 亚洲先锋成人| 国产目拍亚洲精品99久久精品| 亚洲精品社区| 久久久久久久精| 日韩视频一区二区三区在线播放| 久久嫩草精品久久久精品| 亚洲激情影视| 久久青草久久| 一本色道久久综合一区| 激情亚洲成人| 国产精品日韩欧美一区| 免费欧美电影| 久久久国产一区二区三区| 亚洲一区在线看| 国产精品一区二区三区免费观看| 在线欧美小视频| 欧美日韩中文字幕在线| 久久9热精品视频| 亚洲香蕉视频| 亚洲免费观看高清完整版在线观看熊| 亚洲国内精品| 韩日视频一区| 国产日韩专区在线|