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

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>
            久久久久欧美| 亚洲一区久久| 欧美成人性生活| 亚洲国产精品成人精品| 另类激情亚洲| 久久这里只有精品视频首页| 久久国产一区二区三区| 蜜桃av综合| 欧美aaa级| 亚洲影院在线| 欧美一区二区三区在线| 伊人狠狠色丁香综合尤物| 欧美本精品男人aⅴ天堂| 欧美成人a视频| 亚洲一二三四久久| 久久成人国产精品| 999在线观看精品免费不卡网站| 亚洲老司机av| 国产一区二区在线观看免费| 免费成人小视频| 欧美理论电影网| 欧美影院在线播放| 久久综合久久久久88| 在线亚洲伦理| 久久精品综合| 这里只有精品丝袜| 久久精品免费观看| 亚洲婷婷综合色高清在线| 亚洲欧美日韩国产成人精品影院| 亚洲国产一区二区a毛片| 国产精品99久久久久久久久久久久| 国产亚洲欧美色| 最新亚洲一区| 国外视频精品毛片| 亚洲视频精品在线| 亚洲精品国产精品乱码不99 | 久久琪琪电影院| 欧美激情精品久久久久久黑人| 久久国产精品高清| 欧美日韩成人一区二区| 老司机凹凸av亚洲导航| 国产精品白丝黑袜喷水久久久 | 一区二区三区色| 久久精品女人的天堂av| 亚洲欧美另类国产| 欧美激情第3页| 免费欧美电影| 韩国av一区二区三区在线观看| 亚洲美女在线观看| 亚洲激情视频在线| 久久久久久有精品国产| 久久久高清一区二区三区| 欧美特黄a级高清免费大片a级| 欧美成在线观看| 亚洲黄一区二区三区| 久久久五月婷婷| 欧美日韩伦理在线| 欧美韩日一区二区| 在线看片日韩| 久久精品亚洲一区二区| 久久精品123| 国产日韩精品一区二区浪潮av | 中文一区二区在线观看| 美女精品视频一区| 亚洲成色777777在线观看影院 | 欧美日韩精品一区二区在线播放| 欧美国产日韩一区二区| 亚洲国产高清视频| 另类春色校园亚洲| 欧美激情精品久久久久久免费印度| 黄色欧美日韩| 久久伊人亚洲| 欧美激情1区2区| 日韩视频免费观看高清完整版| 男女激情久久| 亚洲日本成人女熟在线观看| 99热在这里有精品免费| 欧美日韩精品免费在线观看视频| 亚洲精品欧美| 一本一本久久a久久精品牛牛影视| 欧美国产综合| 在线中文字幕不卡| 欧美一区=区| 禁断一区二区三区在线| 欧美xart系列高清| 99精品国产高清一区二区| 亚洲在线一区二区| 国产日韩亚洲欧美综合| 久久婷婷国产综合国色天香| 亚洲丰满在线| 午夜精品视频| 精品电影在线观看| 欧美日韩1区2区| 午夜欧美视频| 亚洲国产成人av在线| 亚洲视频999| 国产亚洲综合精品| 欧美大香线蕉线伊人久久国产精品| 亚洲美女在线国产| 久久久中精品2020中文| 日韩亚洲一区二区| 国产欧美精品va在线观看| 久久综合久久88| 亚洲性人人天天夜夜摸| 欧美99在线视频观看| 亚洲一区二区视频| 亚洲高清色综合| 国产精品日日做人人爱| 久久免费视频在线| 亚洲香蕉网站| 最新亚洲电影| 久久综合色婷婷| 亚洲字幕一区二区| 亚洲激情午夜| 黄页网站一区| 国产精品亚洲综合一区在线观看| 美女网站久久| 欧美影院久久久| 亚洲午夜影视影院在线观看| 最新国产成人在线观看| 久久―日本道色综合久久| 亚洲尤物精选| 一区二区三区日韩在线观看 | 精品999日本| 欧美国产免费| 久久激情视频免费观看| 亚洲欧美国产高清| 一区二区av在线| 亚洲人成亚洲人成在线观看| 狂野欧美一区| 久久久噜噜噜久久中文字幕色伊伊| 亚洲一区二区三区精品视频| 亚洲另类春色国产| 亚洲精品1区| 一区视频在线看| 国产一区日韩二区欧美三区| 国产精品性做久久久久久| 欧美日韩国产在线| 欧美精品一区三区| 欧美精品一区二区蜜臀亚洲| 欧美成va人片在线观看| 裸体丰满少妇做受久久99精品| 久久精视频免费在线久久完整在线看| 亚洲综合精品| 亚洲欧美韩国| 欧美在线观看视频在线| 欧美伊人久久久久久久久影院| 性欧美1819性猛交| 久久se精品一区精品二区| 久久爱www| 久久午夜羞羞影院免费观看| 葵司免费一区二区三区四区五区| 久久亚洲综合网| 欧美91大片| 欧美日韩一区二区三区高清| 欧美视频精品在线| 国产精品拍天天在线| 国产亚洲亚洲| 亚洲第一区在线观看| 亚洲另类春色国产| 中文久久乱码一区二区| 欧美一区二区三区婷婷月色| 久久精品国产2020观看福利| 免费欧美日韩| 亚洲毛片在线| 亚洲欧美日韩在线播放| 久久久久国产一区二区三区| 欧美va天堂在线| 欧美日韩中文字幕日韩欧美| 国产精品免费福利| 在线日韩精品视频| 亚洲最快最全在线视频| 新狼窝色av性久久久久久| 免费观看日韩av| 99国内精品久久| 欧美福利视频在线| 99精品视频网| 久久久国产精品亚洲一区| 欧美日韩国产va另类| 国产麻豆视频精品| 亚洲人体1000| 欧美在线免费观看视频| 欧美aⅴ99久久黑人专区| 在线亚洲免费| 老司机久久99久久精品播放免费| 欧美日韩一区二区三区在线观看免 | 亚洲欧美日韩综合| 欧美韩国在线| 国产日韩欧美一二三区| a4yy欧美一区二区三区| 久久久夜夜夜| 在线一区二区三区四区| 欧美99久久| 狠狠色丁香婷婷综合久久片| 艳妇臀荡乳欲伦亚洲一区| 久久亚洲精品网站| 亚洲午夜精品网| 欧美日韩大片| 亚洲国产精品小视频| 久久久国产精彩视频美女艺术照福利 |