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

Benjamin

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

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

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

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

 

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

 

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

將有這已經(jīng)的代碼行注釋掉(這行在頁面上產(chǎn)生“產(chǎn)生 DoxyS”鏈接,它的直接結果就是產(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 相關信息

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

 

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

    /**

    \brief file_文件

    打開文件 \n

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

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

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

    * - r 讀取

    * - w 可寫

    * - a 添加

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

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

    * @return 返回文件編號

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

   

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

     * @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、類的詳細說明:在類簡短說明下面

 

/** \file

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

 

* @author 作者

* @version 版本號

* @date 日期

 

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

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

*/

六、結構體/聯(lián)合體:

/** A test class. 結構體簡要說明. */

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相關設置

首先在“Wizard”標簽的Project項進行如下設置:

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

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

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

然后切換到“Expert”標簽的“HTML”項,設置HTML和CHM相關的選項:

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

編碼設置

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

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

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





posted on 2010-04-25 22:04 Benjamin 閱讀(1299) 評論(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在线播放| 中文网丁香综合网| 亚洲精品免费一二三区| 午夜一区不卡| 国产精品视频不卡| 香蕉av777xxx色综合一区| 99精品欧美一区| 欧美精品v日韩精品v国产精品| 在线日本成人| 久久综合狠狠综合久久综青草| 亚洲欧美在线看| 国产在线成人| 久久久久久9999| 久久国产日韩欧美| 国产性做久久久久久| 久久9热精品视频| 欧美一区激情| 亚洲国产日韩欧美一区二区三区| 久久美女性网| 另类欧美日韩国产在线| 亚洲激情校园春色| 亚洲美女黄网| 国产精品国产精品国产专区不蜜| 午夜精品久久| 亚洲一区二区三区中文字幕| 国产精自产拍久久久久久| 欧美在线观看网站| 久久久久久久一区二区三区| 亚洲黑丝在线| 亚洲麻豆av| 国产日产欧美精品| 亚洲国产精品美女| 欧美二区在线播放| 亚洲一二三区在线| 亚洲女人av| 激情av一区二区| 91久久国产综合久久蜜月精品 | 亚洲专区在线视频| 午夜精品99久久免费| 亚洲国产成人久久| 99pao成人国产永久免费视频| 欧美日韩亚洲国产一区| 欧美在线网址| 欧美多人爱爱视频网站| 香蕉乱码成人久久天堂爱免费| 久久久久久97三级| 宅男噜噜噜66国产日韩在线观看| 欧美亚洲自偷自偷| 99热这里只有成人精品国产| 亚洲精品资源美女情侣酒店| 欧美色欧美亚洲另类二区 | 欧美日韩国产精品自在自线| 久久大综合网| 欧美另类在线播放| 久久天天躁夜夜躁狠狠躁2022| 欧美日韩国产区一| 久久只精品国产| 国产精品午夜国产小视频| 免费亚洲电影在线| 国产日本欧美在线观看| 99视频精品全部免费在线| 激情欧美一区二区三区在线观看| 夜色激情一区二区| 亚洲精品欧美日韩专区| 欧美在线亚洲在线| 亚洲欧美在线播放| 欧美日韩精品免费看| 蜜桃伊人久久| 国产日本欧美视频| 亚洲精品国久久99热| 欧美日韩一区二区高清| 亚洲国产黄色片| 亚洲人成高清| 麻豆精品一区二区av白丝在线| 欧美伊人影院| 欧美午夜电影完整版| 亚洲日本中文| 亚洲日本va午夜在线影院| 久久国产精品网站| 亚洲欧美日本伦理| 欧美经典一区二区| 午夜天堂精品久久久久| 国产精品毛片高清在线完整版| 99国产麻豆精品| 亚洲午夜激情免费视频| 欧美绝品在线观看成人午夜影视 | 国产精品高潮呻吟视频 | 国产欧美精品一区二区三区介绍| 久久视频一区| 国产麻豆精品久久一二三| 欧美一级一区| 美女精品自拍一二三四| 亚洲国产精品999| 久久琪琪电影院| 欧美成年人在线观看| 在线精品亚洲一区二区| 久久一二三四| 亚洲国产日韩在线一区模特| 亚洲精品国产精品乱码不99按摩 | 午夜精品美女久久久久av福利| 欧美日韩一区在线观看视频| 一区二区不卡在线视频 午夜欧美不卡'| 亚洲国产aⅴ天堂久久| 久久久99精品免费观看不卡| 久久人人爽人人爽爽久久| 国产欧美视频在线观看| 欧美中文字幕在线视频| 久久这里只有| 99国产精品一区| 欧美午夜影院| 欧美一区二区免费| 欧美不卡在线视频| 99精品视频免费全部在线| 欧美视频在线观看免费网址| 亚洲在线免费观看| 久久免费国产精品1| 日韩视频在线免费| 国产精品日日摸夜夜添夜夜av| 久久九九久精品国产免费直播| 久久亚洲欧洲| 91久久精品www人人做人人爽| 国产精品免费电影| 久久久久久久久久久久久女国产乱 | 国产嫩草一区二区三区在线观看 | 国产精品系列在线| 久久久欧美精品| 91久久精品国产91久久| 久久九九国产精品| 亚洲免费观看视频| 国产一二三精品| 欧美啪啪一区| 久久久五月婷婷| 99re6这里只有精品| 裸体丰满少妇做受久久99精品| 99精品欧美一区二区三区综合在线| 国产精品毛片大码女人| 欧美激情国产高清| 久久不射2019中文字幕| 亚洲精品三级| 欧美在线视频观看| 91久久精品网| 国产在线精品一区二区夜色| 欧美日韩国产三区| 久久综合国产精品| 欧美一区二区三区四区在线观看 | 狠狠爱综合网| 国产精品免费一区二区三区观看| 久久久久88色偷偷免费| 亚洲色图制服丝袜| 亚洲国产精品久久久久久女王| 亚洲一区二区三区四区视频| 国产亚洲精久久久久久| 欧美国产另类| 欧美在线观看视频在线| 中文久久乱码一区二区| 夜夜狂射影院欧美极品| 亚洲国产导航| 久久久久久久久久久久久9999| 亚洲一区二区三区四区视频| 亚洲巨乳在线| 在线欧美亚洲| 尤物九九久久国产精品的特点| 国产亚洲精品一区二555| 国产日韩精品一区二区| 国产精品美女久久久久久2018 | 一区二区三区在线免费观看| 国产精品入口福利| 国产免费一区二区三区香蕉精| 国产麻豆一精品一av一免费| 国产亚洲制服色| 亚洲精品免费一区二区三区| 一区二区三区精品视频在线观看| 亚洲免费网址| 欧美大片免费久久精品三p| 亚洲精品国产系列| 亚洲影视在线| 免费精品视频| 国产精品久久久一区麻豆最新章节| 国产香蕉久久精品综合网| 一区二区在线观看视频| 中国成人黄色视屏| 久久欧美中文字幕| 艳妇臀荡乳欲伦亚洲一区| 久久精品国产免费观看| 欧美人在线观看| 娇妻被交换粗又大又硬视频欧美| 亚洲日本中文字幕| 久久精品天堂| 日韩视频免费观看高清在线视频| 欧美一区二区三区久久精品茉莉花| 欧美福利精品| 伊人伊人伊人久久| 亚洲免费网站| 亚洲国产日韩综合一区| 亚洲欧美激情精品一区二区| 欧美极品在线播放| 一区二区亚洲精品国产| 午夜在线a亚洲v天堂网2018|