Doxygen for C++使用说明——注释代码一
生活随笔
收集整理的這篇文章主要介紹了
Doxygen for C++使用说明——注释代码一
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
寫這一節的時候，我在想網上有眾多的參考文獻，外加官網上的，要是我再將它們重復一遍，也沒什么意思。網上資料很多，但是他們有一個共同的缺點是都是羅列用法，然后顯示效果。這些都是比較散的，我想是不是可以結合一個具體的范例來講解Doxygen的用法呢？這樣大家既可以學習到語法，也可以直接拿這個模板來用。
我自己在網上下了個模板，并且加了一些內容。這是顯示效果鏈接。下面我將具體來介紹：
先看test.h.
以上為代碼，下面我們將具體說說。
\mainpage
一般我們為一個C++項目建立一個說明文檔，首先應該有個總的項目說明，簡要介紹項目的背景、安裝路徑、使用方法等。這時我們可以在\mainpage中完成。它的語法為：
用法：
\mainpage [(title)]
（Qt風格）示例：
查看效果。
效果與上一模一樣的(JavaDoc風格)的代碼如下：
最上面我們給的源碼實際上使用的是JavaDoc風格。
一般， JavaDoc以兩個**開頭：
Qt 風格以*!開頭
/*!* ... text ...*/兩種用法，注釋塊中間的星號是可選, 所以將注釋塊寫成:
/*!... text ... */\section
用法：
\section <section-name> (section title)說明：
section-name為索引名，section title為章節的標題
我們再介紹一個和\mainpage相似的概念。
\page
用法：
\page <name> (title)示例：
/*! \page page1 A documentation page\tableofcontentsLeading text.\section sec An example sectionThis page contains the subsections \ref subsection1 and \ref subsection2.For more info see page \ref page2.\subsection subsection1 The first subsectionText.\subsection subsection2 The second subsectionMore text. *//*! \page page2 Another pageEven more info. */查看效果。
注意：里面的 \ref 是索引的意思。
\code
用法：
\code [ '{'<word>'}']示例：
\code{.py}class Python:pass\endcode\code{.cpp}class Cpp {};\endcode\brief
用法：
/*! \brief Brief description.** Detailed description starts here.*/如果JAVADOC_AUTOBRIEF 被設置為 YES，則JavaDoc風格將注釋塊中的第一個句子視為簡要描述, 這個句子可以以句號’.’、空格或者空行來結束:
用法：
類的注釋
如下為使用Qt風格的C++代碼注釋。
//! A test class. /*!A more elaborate class description. */ class Test {public://! An enum./*! More detailed enum description. */enum TEnum { TVal1, /*!< Enum value TVal1. */ TVal2, /*!< Enum value TVal2. */ TVal3 /*!< Enum value TVal3. */ } //! Enum pointer./*! Details. */*enumPtr, //! Enum variable./*! Details. */enumVar; //! A constructor./*!A more elaborate description of the constructor.*/Test();//! A destructor./*!A more elaborate description of the destructor.*/~Test();//! A normal member taking two arguments and returning an integer value./*!\param a an integer argument.\param s a constant character pointer.\return The test results\sa Test(), ~Test(), testMeToo() and publicVar()*/int testMe(int a,const char *s);//! A pure virtual member./*!\sa testMe()\param c1 the first argument.\param c2 the second argument.*/virtual void testMeToo(char c1,char c2) = 0;//! A public variable./*!Details.*/int publicVar;//! A function variable./*!Details.*/int (*handler)(int a,int b); };查看效果。
總結
以上是生活随笔為你收集整理的Doxygen for C++使用说明——注释代码一的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Git 工具使用
- 下一篇： s3c2440移植MQTT