C++編程語言應用廣泛，在很多領域中都體現了非常重要的作用。編程人員應用它能夠在很到程度上提高程序開發的效率。在這裡我們先來了解一下有關C++ Doxygen的應用方式，以方便大家的理解。
用C++ Doxygen進行可自動文檔化的代碼注釋，可從代碼中提取注釋生成幫助文檔。
在使用Doxygen時將需要安裝下列軟件：
1、安裝Doxygen1.4.7，建議安裝在“D:\Program Files\doxygen”
2、安裝Graphviz-2.13，用於C++ Doxygen生成類圖、關系圖等圖形，建議安裝在D:\Program Files\ATT。
3、安裝HtmlHelp1.3，用於生成CHM幫助文件，如果已安裝了HtmlHelp其他版本則跳過。
下面對三種常見形式舉例。
A. 文件頭注釋，\file, \brief
B. 類/結構體等的定義注釋，先寫名稱，再寫概要說明
C. 函數定義說明，先寫名稱，再寫概要說明，然後寫參數說明、返回值、注意事項、參見鏈接等
在函數定義中常用的有1）參數 param2）返回值 return 3）參見 see4）注意項 note等
參數可指定in/out，例如@param[out] dest、@param[in,out] buffer
D. 成員變量的注釋，如果注釋寫在變量右邊，則加“<”，例如//!< ……
更深層次的標記請查看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. 類/結構體等的定義注釋
- /*! 出版者就是將要被觀察的對象
- \interface Ix_Subject
- */
- struct Ix_Subject
- {
- //! 添加觀察者 C. 函數定義注釋
- /*!
- \param observer 要添加的觀察者
- \see Ix_Observer
- */
- virtual void Attach(Ix_Observer* observer) = 0;
- //! 去掉觀察者
- /*!
- \param observer 要去掉的觀察者
- \see Ix_Observer
- */
- virtual bool Detach(Ix_Observer* observer) = 0;
- //! 改變時通知所有觀察者
- /*!
- \param data 通知參數，可為NULL
- */
- virtual void Notify(void* data) = 0;
- };
- //! 二維點結構
- struct POINT2D
- {
- double x; //!< X坐標分量 D. 枚舉/結構體/類的成員變量注視
- double y; //!< Y坐標分量 在定義項右邊時加“<”，在其上面一行則不加
- };
- //! 觀察者的接口
- /*! \interface Ix_Observer
- */
- struct Ix_Observer
- {
- //! 改變的通知
- /*!
- \param data 通知參數
- \param subject 發布改變通知的出版者,其他其他其他其他
- 其他其他其他其他其他其他其他其他其他
- */
- virtual void Update(void* data, const Ix_Subject* subject) = 0;
- };
一上就是對C++ Doxygen的相關操作的介紹。
