Qt Creator中变量与函数的注释 - 鼠标悬浮可显示

Qt Creator中变量与函数的注释 - 鼠标悬浮可显示

引言

代码注释在软件开发中起着至关重要的作用。它们不仅有助于开发者理解和维护代码,还能促进团队协作,提高代码的可读性和可维护性。适当的注释应该是简洁明了、有针对性的,能够真正帮助其他开发者以及未来的自己理解和使用代码。

本文主要针对c++类中的变量和函数. 鼠标悬浮或写代码时有相关注释提示。

一、变量注释

对类中的变量进行注释:

    1. 效果展示 (鼠标悬浮在相应变量即可显示注释,写代码时代码补全也会提示):

    1. 源码 (注释方式)
      一般都使用//、///进行单行注释,使用/* */进行多行注释. 但是在Qt Creator中使用以上注释方式没有相关提示。
      使用///<进行单行注释,使用/** */进行多行注释,则鼠标悬浮会显示相应的注释。
cpp 复制代码
    int m_int; ///< 一个普通的int变量
    double m_doubel; /**< 一个普通的double变量 */
    /**
     * @brief 一个普通的float变量
     */
    float m_float;

二、函数注释

对类中的函数进行注释:

    1. 效果展示 (简单举了两个例子)
    1. 源码 (注释方式)
      常用的是/** */以及@brief说明函数作用,输入/**回车即可自动补全。
      (还可以使用/*!、//!、///以及\brief等,有多种注释 (函数上方)只会显示离函数最近的一个)
cpp 复制代码
    /**
     * @brief a
     */
    void a();

    /*!
     * \brief b
     */
    void b();

    //!
    //! \brief c
    //!
    void c();
    
    /// d
    /// dd
    /// ddd
    void d();
    1. 常用的注释规范
@项 描述
@brief 函数简介 (鼠标悬浮会显示)
@param 参数介绍
@return 函数返回介绍
@author 作者简介
@version 版本说明
@data 创建 or 修改时间
@exception 异常说明
@... ...
    1. 还可以在文本编辑器设置:自定义自动给函数生成注释模版

Qt Creator自动给函数生成注释模板:https://blog.csdn.net/qq_21449473/article/details/118223381

三、参考链接

Qt Creator中一些常用小技巧(总结):https://blog.csdn.net/Littlehero_121/article/details/105784118

Qt Creator 关于变量注释的正确写法:https://blog.csdn.net/becklee2011/article/details/116784871

QtCreator中自动补全注释:https://blog.csdn.net/u010168781/article/details/87725403

在 Qt Creator 中编写 Doxygen 风格的注释:https://blog.csdn.net/m0_61629312/article/details/134905164

C++与Doxygen:精通代码文档化之道:https://blog.csdn.net/qq_21438461/article/details/135072700

相关推荐
Java展博1 天前
[Go 后端转场] 从 try-catch 到 if err != nil:写惯 Java 的人第一次上手最别扭的 4 件事
java·开发语言·golang
SEO_juper1 天前
Node.js 全站 SEO 体检报告生成器:一次查完标题、描述、canonical、H1、图片
开发语言·前端·node.js·html·bash
风落青芜1 天前
数据结构:堆的概念与实现
c语言·开发语言·数据结构·算法
H H.1 天前
Java企业级开发:从框架到工程化实战
java·开发语言·经验分享·其他·课程设计
吃我一窝jio2 天前
Python与Go线程模型深度对比
java·开发语言·python
eggwyw2 天前
C++ union 的一种妙用法
开发语言·c++
ShineWinsu2 天前
对于Qt:QHBoxLayout常见属性以及方法的解析
c++·qt·面试·gui·客户端·布局管理器·水平布局器
starzy19902 天前
深入理解Scala隐式函数:自动类型转换
开发语言·后端·scala
布莱克6052 天前
Swift 循环与控制转移详解:从 for-in 到标签跳转
开发语言·ssh·swift·循环
敲上瘾2 天前
Qt核心机制:信号与槽详解
开发语言·c++·qt·ui·qt6.3