QT 注释模板

50 篇文章 3 订阅

QT中注释一般就有:

 1.单行注释 //
    //int a;
    //return a+b;

2.多行注释/**/
void MainWindow::dropEvent(QDropEvent *event)
{
    /*
    QString name = event->mimeData()->urls().first().toString();
    ui->lineEdit->setText(name);
    */
}

3.函数注释模板注释
/**
 * @brief MainWindow::addMethod 计算两个数值的和
 * @param a 第一个参数
 * @param b 第二个参数
 * @return  返回 a+b的值
 */
int MainWindow::addMethod(int a, int b)
{
    return a + b;
}

关于这一种函数注释方式有种简便的生成方式:在函数上方输入/** 然后按下回车,就会自动生成以上模板。

@brief : 对于这个函数的简单描述

@param  :参数

@return : 返回值




  • 4
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Qt中编写头文件注释模板,通常会遵循一定的格式来提供类的描述、作者信息、版权信息以及创建和修改日期等。一个典型的Qt头文件注释模板可能如下所示: ```cpp #ifndef MYCLASS_H #define MYCLASS_H /*! \class MyClass \brief 简短的类描述,通常是类的主要功能或用途。 详细的类描述可以包含多行,通常会说明类的用途、提供的主要功能、使用方法等。 你还可以在这里添加关于类的结构、主要成员函数和变量的说明。 */ /*! \brief 构造函数的简要描述。 \param 参数1 描述 \param 参数2 描述 ... 构造函数的详细描述,可以包含参数列表以及如何使用构造函数。 */ MyClass::MyClass(/* 参数列表 */) : /* 初始化列表 */ { // 类成员变量的初始化代码 } /*! \brief 析构函数的简要描述。 析构函数通常不需要参数,其详细描述可以解释为什么需要析构函数以及它的特殊功能。 */ MyClass::~MyClass() { // 析构函数的代码 } // 接下来定义类的成员函数 /*! \brief 成员函数的简要描述。 \param 参数1 描述 \param 参数2 描述 ... 成员函数的详细描述,可以包含参数列表、返回值以及函数的用途。 */ void MyClass::functionName(/* 参数列表 */) { // 函数体代码 } // 其他成员函数的定义... // 成员变量的声明... #endif // MYCLASS_H ``` 在这个模板中,使用了`\`命令来生成注释,这些命令是Doxygen风格的注释,可以生成文档。注释中可以包含HTML标签来增强格式。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值