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

Benjamin

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

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

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

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

 

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

 

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

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

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

 

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

 

 

附錄:編寫注釋規范

一、函數注釋:

/**

\brief

簡短注釋

\n

* @param[in] 輸入參數

* @param[out] 輸出參數

* @return 返回值

* @note 注解

* @par 示例

* @code 代碼

* @endcode

* @see 參見

* @deprecated 相關信息

也可以在@param后面直接跟參數

 

示例:函數OpenFile的注釋

    /**

    \brief file_文件

    打開文件 \n

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

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

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

    * - r 讀取

    * - w 可寫

    * - a 添加

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

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

    * @return 返回文件編號

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

   

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

     * @par 示例:

     * @code

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

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

     * @endcode

     

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

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

    */

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"

/** 數據文件名 */

#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類對象包含問題規定的對象屬性

 

* @author 作者

* @version 版本號

* @date 日期

 

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

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

*/

六、結構體/聯合體:

/** 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項,根據需要設置文檔生成模式。

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

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

  • GENERATE_HTMLHELP:確保已經勾選了
  • 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”

編碼設置

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

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

  • Project/DOXYFILE_ENCODING:當前 Doxygen 配置文件本身的字符編碼,默認為UTF-8,一般不需要修改
  • Project/OUTPUT_LANGUAGE:輸出語言。這里是指Doxygen自己生成的導航、提示、幫助等文本的文字采用的語言。我們希望幫助文檔是全中文的,所以選擇Chinese
  • Input/INPUT_ENCODING:輸入文件的編碼。這里是指我們的源代碼文件本身的編碼。在Windows平臺一般是系統編碼(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>
            亚洲高清视频在线观看| a91a精品视频在线观看| 国内视频一区| 在线欧美电影| 在线国产亚洲欧美| 久久精品国产精品亚洲| 亚洲欧美电影在线观看| 在线成人免费观看| 久久综合国产精品| 久久综合电影| 西西人体一区二区| 99riav国产精品| 加勒比av一区二区| 亚洲欧美日韩电影| 国产区日韩欧美| 亚洲一区二区三区四区五区黄| 欧美亚州一区二区三区 | 夜夜精品视频一区二区| 亚洲七七久久综合桃花剧情介绍| 久久精品国产999大香线蕉| 久久精品免费播放| 久久精品在这里| 亚洲尤物在线视频观看| 亚洲综合色视频| 亚洲影视中文字幕| 国产亚洲人成a一在线v站| 国产一区二区三区成人欧美日韩在线观看 | 欧美自拍偷拍| 99国产精品99久久久久久| 欧美成人激情视频| 欧美午夜精品理论片a级按摩| 国产女人水真多18毛片18精品视频| 国产欧美1区2区3区| 免费观看在线综合| 国产精品久久久久77777| 老司机aⅴ在线精品导航| 欧美寡妇偷汉性猛交| 乱中年女人伦av一区二区| 欧美亚洲免费电影| 亚洲专区一区二区三区| 亚洲人成绝费网站色www| 欧美在线观看视频一区二区三区| 一区二区精品| 欧美激情精品久久久六区热门| 国产精品久久久久影院亚瑟| 久久精品色图| 欧美精品v日韩精品v韩国精品v | 欧美粗暴jizz性欧美20| 亚洲伊人观看| 国产精品白丝av嫩草影院| 亚洲欧美在线一区二区| 国产精品一区免费观看| 免费高清在线一区| 9人人澡人人爽人人精品| 欧美日韩成人一区二区| 亚洲一区二区三区在线| 亚洲国产精品一区二区www| 欧美日韩国产综合网| 亚洲视频国产视频| 99精品99| 欧美在线一二三四区| 美女日韩在线中文字幕| 亚洲欧洲一区二区三区久久| 久久免费视频在线观看| 亚洲高清色综合| 亚洲日韩第九十九页| 狠狠色噜噜狠狠狠狠色吗综合| 久久精品日产第一区二区三区| 久久精品国产亚洲精品| 久久久久一区二区三区| 亚洲欧洲日韩女同| 欧美怡红院视频| 午夜日本精品| 亚洲中字黄色| 欧美系列一区| 久久人人97超碰国产公开结果| 亚洲精品字幕| 亚洲精品1区2区| 亚洲第一精品电影| 国产精品爽爽ⅴa在线观看| 久久一区二区视频| 久久亚洲精品网站| 一区二区三区欧美| 欧美大胆a视频| 欧美一区午夜视频在线观看| 亚洲国产一区在线| 国产日韩精品久久| 亚洲另类自拍| 美女黄色成人网| 亚洲一二三区在线观看| 一区二区三区 在线观看视| 亚洲大片免费看| 欧美日韩mp4| 一区二区高清视频在线观看| 久久福利精品| 亚洲视频二区| 欧美日韩国产综合一区二区| 亚洲资源在线观看| 欧美一级理论片| 亚洲午夜未删减在线观看| 在线一区亚洲| 欧美一级一区| 久久夜色精品一区| 国产精品高潮在线| 久久先锋资源| 欧美日韩国产亚洲一区| 最新国产精品拍自在线播放| 欧美成人午夜激情| 99re66热这里只有精品4| 国产综合色在线| 亚洲国产精品第一区二区| 欧美理论在线| 亚洲天堂av图片| 亚洲精品视频免费| 亚洲一区二区三区高清| 久久久亚洲国产天美传媒修理工 | 美女诱惑黄网站一区| 久热re这里精品视频在线6| 亚洲美女区一区| 亚洲综合二区| 亚洲精品一区二| 久久精品卡一| 久久久精品网| 久久精品视频在线| 国产精品成人一区二区| 1769国产精品| 久久亚洲美女| 久久综合狠狠综合久久激情| 亚洲免费观看在线观看| 亚洲美女色禁图| 夜夜夜久久久| 欧美日韩亚洲在线| 国产精品久久久久久户外露出| 亚洲精品美女| 亚洲精品乱码久久久久久| 欧美在线免费播放| 国内精品嫩模av私拍在线观看| 欧美一区二区三区视频在线观看 | 欧美国产专区| 亚洲另类在线视频| 久久精品视频一| 久久久国产成人精品| 久久综合给合久久狠狠色| 国产精品v欧美精品v日韩精品| 欧美日韩中文| 国产精品久久福利| 狠狠久久亚洲欧美| 欧美成人四级电影| 日韩视频一区二区三区在线播放| 欧美日韩第一区| 久久精品首页| 正在播放欧美一区| 好看的av在线不卡观看| 亚洲巨乳在线| 99视频一区二区| 亚洲七七久久综合桃花剧情介绍| 欧美福利小视频| 韩国av一区二区三区四区| 欧美在线高清| 欧美在线观看视频一区二区三区 | 狼人天天伊人久久| 亚洲精品中文字| 欧美日韩激情小视频| 亚洲天堂av综合网| 久久精视频免费在线久久完整在线看| 国产日本欧美视频| 亚洲国产精品成人| 9l国产精品久久久久麻豆| 欧美国产欧美亚洲国产日韩mv天天看完整 | 欧美午夜在线视频| 中文精品视频| 欧美视频不卡| 免费av成人在线| 欧美日韩一级视频| 亚洲一区区二区| 亚洲国产裸拍裸体视频在线观看乱了中文 | 久久资源在线| 亚洲乱码国产乱码精品精98午夜| 午夜久久久久久久久久一区二区| 久久精品在线观看| 欧美激情精品久久久久久大尺度 | 欧美激情一区在线| 亚洲综合99| 午夜精品久久久久久久白皮肤| 欧美视频日韩| 一区二区三区国产| 欧美大片在线观看一区| 欧美在线观看网址综合| 亚洲国产天堂久久国产91| 国产精品日韩在线| 免费在线亚洲| 韩日成人av| 经典三级久久| 日韩视频在线观看免费| 夜夜夜久久久| 欧美伊人影院| 在线欧美亚洲| 好看的亚洲午夜视频在线| 国产综合久久| 在线观看成人网|