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

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>
            99re在线精品| 欧美一区二区免费观在线| 狂野欧美激情性xxxx| 国产一区二区精品丝袜| 久久精品日产第一区二区| 欧美在线www| 伊伊综合在线| 亚洲国产国产亚洲一二三| 久久久免费观看视频| 在线观看成人av电影| 亚洲国产日韩精品| 欧美日韩中文字幕在线视频| 亚洲一区二区黄色| 亚洲一区视频在线| 狠狠色狠狠色综合日日小说 | 猛干欧美女孩| av不卡在线看| 午夜在线a亚洲v天堂网2018| 狠狠爱综合网| 亚洲人成在线观看| 国产欧美视频一区二区| 老司机午夜精品视频在线观看| 蜜臀av性久久久久蜜臀aⅴ| 宅男精品视频| 欧美一级片在线播放| 亚洲精品裸体| 午夜激情综合网| 亚洲精品之草原avav久久| 亚洲一区二区三区四区五区黄| 国产亚洲人成网站在线观看| 亚洲丁香婷深爱综合| 国产精品日日摸夜夜添夜夜av| 毛片一区二区| 国产精品久久二区| 欧美激情视频一区二区三区免费 | 女同性一区二区三区人了人一| 日韩亚洲一区二区| 欧美一区二区精品| 一本一本久久a久久精品综合妖精| 亚洲欧美色一区| 一本大道av伊人久久综合| 久久成人免费电影| 亚洲女女女同性video| 久久一区二区精品| 欧美在线免费观看视频| 欧美日韩高清在线| 欧美成人一区二区三区| 国产精品永久免费在线| 亚洲免费观看高清完整版在线观看熊| 国内精品久久久久影院色| 在线中文字幕一区| 99精品国产高清一区二区| 久久久www成人免费毛片麻豆| 亚洲欧美三级伦理| 欧美日韩一二三区| 亚洲精品国产精品国自产在线 | 欧美激情中文不卡| 蜜臀va亚洲va欧美va天堂| 国产精品欧美日韩| 日韩亚洲欧美一区二区三区| 亚洲啪啪91| 另类激情亚洲| 嫩草影视亚洲| 亚洲高清在线精品| 蜜月aⅴ免费一区二区三区 | 亚洲一区二区免费在线| 欧美精品三级日韩久久| 欧美黄色免费| 亚洲美女电影在线| 欧美日韩精品三区| 亚洲精品欧美日韩专区| 99成人免费视频| 欧美日韩国产在线播放| 亚洲精品在线看| 在线综合欧美| 国产精品女人网站| 亚洲男人的天堂在线| 久久国产精品一区二区三区四区 | 欧美色网一区二区| 99视频一区二区三区| avtt综合网| 国产精品国产亚洲精品看不卡15 | 久久永久免费| 亚洲电影免费在线| 欧美精品色综合| 亚洲精选中文字幕| 小黄鸭精品密入口导航| 国产色爱av资源综合区| 久久久欧美精品| 亚洲国产另类精品专区| 亚洲婷婷综合色高清在线| 国产精品毛片a∨一区二区三区| 亚洲欧美日韩在线观看a三区| 久久视频在线视频| 99精品视频免费观看视频| 国产精品成人国产乱一区| 亚洲自拍三区| 欧美顶级大胆免费视频| 亚洲视频一区| 国产专区精品视频| 欧美女激情福利| 欧美一区亚洲二区| 亚洲激情影视| 久久精品99国产精品酒店日本| 亚洲国产天堂久久综合| 欧美日韩午夜在线视频| 久久精品夜色噜噜亚洲aⅴ| 91久久极品少妇xxxxⅹ软件| 午夜精品福利在线| 亚洲日本va午夜在线电影| 欧美午夜一区二区福利视频| 久久精品99国产精品酒店日本| 欧美国产一区二区在线观看| 亚洲资源在线观看| 亚洲国产精品精华液2区45| 国产精品欧美久久| 欧美激情第8页| 久久久不卡网国产精品一区| 99视频日韩| 亚洲福利视频三区| 久久精品欧美日韩| 国产精品久久久久一区二区三区| 夜色激情一区二区| 国产一区二区三区日韩| 欧美精品国产一区| 久久久久久噜噜噜久久久精品| 欧美自拍丝袜亚洲| 性欧美video另类hd性玩具| 欧美伊人久久| 榴莲视频成人在线观看| 亚洲第一区在线观看| 日韩视频一区二区| 亚洲综合精品自拍| 久久久久久色| 欧美日韩调教| 国产在线精品自拍| 亚洲三级影片| 午夜视频久久久| 欧美电影专区| 亚洲一级片在线观看| 久久精品免费看| 欧美精品在线视频| 国产欧美一区二区精品婷婷| 亚洲第一福利在线观看| 在线视频你懂得一区| 欧美专区日韩视频| 91久久国产自产拍夜夜嗨| 亚洲最新在线| 久久久人人人| 国产精品久久久久久久久久免费 | 亚洲一区免费观看| 久久亚洲图片| 99热在线精品观看| 久久久久久电影| 国产精品草莓在线免费观看| 狠狠色狠狠色综合| 亚洲一区影音先锋| 欧美成年网站| 性欧美8khd高清极品| 欧美激情在线有限公司| 韩国一区二区三区美女美女秀| 亚洲美女在线观看| 久久夜色精品| 亚洲一区精彩视频| 欧美理论电影网| 影音先锋亚洲电影| 久久大综合网| 一区二区日韩| 欧美精品v日韩精品v韩国精品v | 性欧美18~19sex高清播放| 欧美大尺度在线| 在线播放亚洲| 久久久久久一区| 亚洲综合精品一区二区| 欧美日韩成人综合在线一区二区| 韩日欧美一区二区| 久久成人久久爱| 亚洲午夜久久久久久久久电影院| 欧美激情精品久久久久久久变态| 激情五月婷婷综合| 久久激情一区| 亚洲欧美日韩系列| 国产精品美女诱惑| 亚洲男人av电影| 中国亚洲黄色| 欧美视频在线观看免费| 亚洲美女少妇无套啪啪呻吟| 老鸭窝亚洲一区二区三区| 午夜在线精品| 国产精品视频男人的天堂| 亚洲一区二区动漫| 野花国产精品入口| 欧美色偷偷大香| 亚洲欧美激情视频| 亚洲图片激情小说| 国产乱码精品一区二区三区忘忧草| 亚洲小说春色综合另类电影| 亚洲精品在线免费| 欧美成人高清| 99re6这里只有精品|