建站
咨詢
售后
建站咨詢
新聞中心
C++編程語言應(yīng)用廣泛，在很多領(lǐng)域中都體現(xiàn)了非常重要的作用。編程人員應(yīng)用它能夠在很到程度上提高程序開發(fā)的效率。在這里我們先來了解一下有關(guān)C++ Doxygen的應(yīng)用方式，以方便大家的理解。#t#
成都創(chuàng)新互聯(lián)公司專注于企業(yè)全網(wǎng)整合營銷推廣、網(wǎng)站重做改版、保德網(wǎng)站定制設(shè)計(jì)、自適應(yīng)品牌網(wǎng)站建設(shè)、H5場景定制、商城開發(fā)、集團(tuán)公司官網(wǎng)建設(shè)、成都外貿(mào)網(wǎng)站制作、高端網(wǎng)站制作、響應(yīng)式網(wǎng)頁設(shè)計(jì)等建站業(yè)務(wù)，價(jià)格優(yōu)惠性價(jià)比高，為保德等各大城市提供網(wǎng)站開發(fā)制作服務(wù)。
用C++ Doxygen進(jìn)行可自動(dòng)文檔化的代碼注釋，可從代碼中提取注釋生成幫助文檔。
在使用Doxygen時(shí)將需要安裝下列軟件：
1、安裝Doxygen1.4.7，建議安裝在“D:\Program Files\doxygen”
2、安裝Graphviz-2.13，用于C++ Doxygen生成類圖、關(guān)系圖等圖形，建議安裝在D:\Program Files\ATT。
3、安裝HtmlHelp1.3，用于生成CHM幫助文件，如果已安裝了HtmlHelp其他版本則跳過。
下面對三種常見形式舉例。
A. 文件頭注釋，\file, \brief
B. 類/結(jié)構(gòu)體等的定義注釋，先寫名稱，再寫概要說明
C. 函數(shù)定義說明，先寫名稱，再寫概要說明，然后寫參數(shù)說明、返回值、注意事項(xiàng)、參見鏈接等
在函數(shù)定義中常用的有（1）參數(shù) param（2）返回值 return （3）參見 see（4）注意項(xiàng) note等
參數(shù)可指定in/out，例如@param[out] dest、@param[in,out] buffer
D. 成員變量的注釋，如果注釋寫在變量右邊，則加“<”，例如//!< ……
更深層次的標(biāo)記請查看C++ Doxygen幫助中的“Documenting the code”，Doxygen用法后面演示說明。
- //! \file Ix_Observer.h A. 文件頭注釋，用于在幫助文件中列出文件列表
- //! \brief 定義出版者和觀察者的接口Ix_Subject、Ix_Observer
- #pragma once
- struct Ix_Subject;
- struct Ix_Observer;
- //! 出版者的接口 B. 類/結(jié)構(gòu)體等的定義注釋
- /*! 出版者就是將要被觀察的對象
- \interface Ix_Subject
- */
- struct Ix_Subject
- {
- //! 添加觀察者 C. 函數(shù)定義注釋
- /*!
- \param observer 要添加的觀察者
- \see Ix_Observer
- */
- virtual void Attach(Ix_Observer* observer) = 0;
- //! 去掉觀察者
- /*!
- \param observer 要去掉的觀察者
- \see Ix_Observer
- */
- virtual bool Detach(Ix_Observer* observer) = 0;
- //! 改變時(shí)通知所有觀察者
- /*!
- \param data 通知參數(shù)，可為NULL
- */
- virtual void Notify(void* data) = 0;
- };
- //! 二維點(diǎn)結(jié)構(gòu)
- struct POINT2D
- {
- double x; //!< X坐標(biāo)分量 D. 枚舉/結(jié)構(gòu)體/類的成員變量注視
- double y; //!< Y坐標(biāo)分量 在定義項(xiàng)右邊時(shí)加“<”，在其上面一行則不加
- };
- //! 觀察者的接口
- /*! \interface Ix_Observer
- */
- struct Ix_Observer
- {
- //! 改變的通知
- /*!
- \param data 通知參數(shù)
- \param subject 發(fā)布改變通知的出版者,其他其他其他其他
- 其他其他其他其他其他其他其他其他其他
- */
- virtual void Update(void* data, const Ix_Subject* subject) = 0;
- };
一上就是對C++ Doxygen的相關(guān)操作的介紹。
網(wǎng)頁題目：C++Doxygen實(shí)現(xiàn)功能分享
鏈接URL：http://fisionsoft.com.cn/article/dhsppsc.html
