自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

C++ Doxygen實現(xiàn)功能分享

開發(fā) 后端
C++ Doxygen主要可以為我們實現(xiàn)文檔化代碼注釋的自動才生成。那么接下來就讓我們一起來看看這方面技巧應(yīng)用的具體操作方法。

C++編程語言應(yīng)用廣泛,在很多領(lǐng)域中都體現(xiàn)了非常重要的作用。編程人員應(yīng)用它能夠在很到程度上提高程序開發(fā)的效率。在這里我們先來了解一下有關(guān)C++ Doxygen的應(yīng)用方式,以方便大家的理解。#t#

用C++ Doxygen進(jìn)行可自動文檔化的代碼注釋,可從代碼中提取注釋生成幫助文檔。

在使用Doxygen時將需要安裝下列軟件:

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ù)說明、返回值、注意事項、參見鏈接等

在函數(shù)定義中常用的有(1)參數(shù) param(2)返回值 return (3)參見 see(4)注意項 note等

參數(shù)可指定in/out,例如@param[out] dest、@param[in,out] buffer

D. 成員變量的注釋,如果注釋寫在變量右邊,則加“<”,例如//!< ……

更深層次的標(biāo)記請查看C++ Doxygen幫助中的“Documenting the code”,Doxygen用法后面演示說明。

 

 

 

  1. //! \file Ix_Observer.h A. 文件頭注釋,用于在幫助文件中列出文件列表  
  2. //! \brief 定義出版者和觀察者的接口Ix_Subject、Ix_Observer  
  3. #pragma once  
  4. struct Ix_Subject;  
  5. struct Ix_Observer;  
  6. //! 出版者的接口 B. 類/結(jié)構(gòu)體等的定義注釋  
  7. /*! 出版者就是將要被觀察的對象  
  8. \interface Ix_Subject  
  9. */  
  10. struct Ix_Subject  
  11. {  
  12. //! 添加觀察者 C. 函數(shù)定義注釋  
  13. /*!  
  14. \param observer 要添加的觀察者  
  15. \see Ix_Observer  
  16. */  
  17. virtual void Attach(Ix_Observer* observer) = 0;  
  18. //! 去掉觀察者  
  19. /*!  
  20. \param observer 要去掉的觀察者  
  21. \see Ix_Observer  
  22. */  
  23. virtual bool Detach(Ix_Observer* observer) = 0;  
  24. //! 改變時通知所有觀察者  
  25. /*!  
  26. \param data 通知參數(shù),可為NULL  
  27. */  
  28. virtual void Notify(void* data) = 0;  
  29. };  
  30. //! 二維點結(jié)構(gòu)  
  31. struct POINT2D  
  32. {  
  33. double x; //!< X坐標(biāo)分量 D. 枚舉/結(jié)構(gòu)體/類的成員變量注視  
  34. double y; //!< Y坐標(biāo)分量 在定義項右邊時加“<”,在其上面一行則不加  
  35. };  
  36. //! 觀察者的接口  
  37. /*! \interface Ix_Observer  
  38. */  
  39. struct Ix_Observer  
  40. {  
  41. //! 改變的通知  
  42. /*!  
  43. \param data 通知參數(shù)  
  44. \param subject 發(fā)布改變通知的出版者,其他其他其他其他  
  45. 其他其他其他其他其他其他其他其他其他  
  46. */  
  47. virtual void Update(void* data, const Ix_Subject* subject) = 0;  
  48. }; 

 

一上就是對C++ Doxygen的相關(guān)操作的介紹。

責(zé)任編輯:曹凱 來源: 博客園
相關(guān)推薦

2010-02-05 16:25:10

C++ strtok(

2010-02-03 15:52:55

C++ clock()

2010-01-11 11:02:59

Visual C++

2010-02-04 11:38:43

C++獲取當(dāng)前路徑

2024-01-31 08:33:06

C++編程計算器

2010-02-01 11:13:00

C++ Traits

2011-07-13 16:36:11

C++

2011-07-13 17:42:32

CC++

2011-07-13 17:08:02

CC++

2011-07-13 16:48:55

CC++

2010-02-03 13:22:07

C++時間

2010-02-06 13:47:08

C++標(biāo)準(zhǔn)擴(kuò)展

2011-07-01 10:16:08

C++內(nèi)存管理

2010-02-04 14:58:06

C++內(nèi)存分配

2023-10-30 10:29:50

C++最小二乘法

2014-04-04 09:53:18

2048C++

2010-02-04 15:19:38

C++獲取CPU信息

2010-02-01 17:09:07

C++鏈表操作

2010-02-05 13:44:06

C++ eof()函數(shù)

2010-01-27 18:06:03

Android短信發(fā)送
點贊
收藏

51CTO技術(shù)棧公眾號