Doxygen 的简单注释

最新推荐文章于 2025-09-10 22:18:24 发布

原创最新推荐文章于 2025-09-10 22:18:24 发布 · 866 阅读

0 ·

CC 4.0 BY-SA版权

Others 专栏收录该内容

28 篇文章

订阅专栏

本文深入探讨了测试类的实现及其在软件开发过程中的作用，包括枚举、构造函数、析构函数等核心组件。同时，介绍了与文档协作相关的工具和技术，如Confluence、石墨文档等，旨在提升团队协作效率与文档质量。

//!  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);};

#include <QtGui/QDialog>
#include "ui_testdoc.h"
///  这个类的名字叫TestDoc. 
///  这个类是用来玩什么的呢，
///  这个类是用来玩什么的呢，
///  这个类是用来玩什么的呢，
///  这个类是用来玩什么的呢，
class TestDoc : public QDialog
{
	Q_OBJECT

public:
	/// 这里是构造函数.
	/// @param parent 是父母
	/// @param flag 是个小参数
	TestDoc(QWidget *parent = 0, Qt::WFlags flags = 0);
	~TestDoc();

private:
	Ui::TestDocClass ui;

public:
	
	int dd;  /*!< an dddddddddddddd value */

};

#endif // TESTDOC_H

注释中文不乱码要把 Input_Endoding 设置为 GB2312，

Expert - Build 中有许多选项哦！！！比如输入 static 和private