常见编程软件注释 @brief @param @return

最新推荐文章于 2025-04-15 10:41:42 发布

嵌入式小刘

最新推荐文章于 2025-04-15 10:41:42 发布

阅读量10w+

点赞数 12

分类专栏： c语言 Qt学习笔记

本文链接：https://blog.csdn.net/qq_40305944/article/details/115270662

版权

Qt 代码注释自动补全编程规范函数描述

关键词由CSDN通过智能技术生成

c语言同时被 2 个专栏收录

17 篇文章

订阅专栏

Qt学习笔记

3 篇文章

订阅专栏

本文介绍了Qt开发中代码注释的规范，包括`@brief`、`@param`、`@return`等关键字段的使用，以及如何利用Qt的自动补全功能提高编码效率。此外，还提到了一些注意事项，如注释开头需为`/**`，`@`和`*`之间需有空格，并避免在注释中使用中文输入法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

/**
 * @brief  @param  @return @author @date @version是代码书写的一种规范
 * @brief  ：简介，简单介绍函数作用
 * @param  ：介绍函数参数
 * @return：函数返回类型说明
 * @exception NSException 可能抛出的异常.
 * @author zhangsan：  作者
 * @date 2011-07-27 22:30:00 ：时间
 * @version 1.0 ：版本  
 * @property ：属性介绍
 * */

在上述注释中，输入注释后就会高亮。

在qt中有自带的会弹出注释，在输入@后这样你就可以选择了,有个小技巧，就是第二行开头输入一个星号*，回车后的其他行的星号* Qt是会自动补充的。

qt中有自带注释根据实测需注意一些几点，不同版本不同系统可能会有不同，欢迎留言补充：

（1）开头是/** 有两个星号不然无法自动弹出注释

（2）@和星号(*)之间需要一个空格不然无法自动弹出注释，

（3）@和星号*不能用中文输入法不然也无法自动弹出注释。

还可添加自己的注释字段

例如：

    /**
     * @brief Create new QToolButton
     *
     * @param name Name of button
     * @param action iconPath Path to button icon.
     * @return QToolButton Created QToolButton.
     */
    QToolButton* createToolButton(QAction *action);