Qt Creator 快速注释

十日十行2025-10-28 15:27

对于函数和类的即时注释

将光标放在函数声明行的上方，输入 ///然后直接按 Enter键。Qt Creator 会自动生成一个包含 @brief、@param（参数）和 @return（返回值）标签的注释骨架。

perl 复制代码

/// @brief 计算两个整数的和
///
/// @param a 第一个整数
/// @param b 第二个整数
///
/// @return 两个整数的和
int add(int a, int b);

其他快捷方式：你也可以尝试使用 /**或 /*!后跟回车，同样可以触发自动注释生成，生成的格式可能略有不同.
Doxygen 集成 ：这些自动生成的注释标签（如 @brief、@param）是兼容 Doxygen 的。这意味着你可以直接使用这些注释来生成项目的 API 文档

less 复制代码

@def 宏定义说明
@fn 函数 函数说明
@param 参数 参数说明
@return 返回值说明(出错返回什么值，等等)
@file 文件名
@author 作者
@version 程序版本
@date 日期
@note 注解(注意事项，等)
@warning 警告信息
@bug bug信息
@test 测试示例、信息
@todo 一些未完事宜
(@bug、@test以及@todo等会出现链接页面)
上面这样适合在函数、文件前面出现。
下面为生成特殊字体的命令：
@a @e @em：其后的单个字(word)表现为斜体，以强调作用。如有多个word的话，使用<em>xxx xxx</em>代替。
@b：其后的word为粗体，多个则使用<b>xxx xxx</b>。
@c @p：字体表现为打印机字体，多个则使用<tt>xxx xxx</tt>。

注释风格: (下面的注释方式会被doxygen文档化) JavaDoc风格

arduino 复制代码

/**
* ... text ...
*/

markdown 复制代码

/*!
* ... text ... 中间的星号(*)是可选的
*/

C++风格

arduino 复制代码

///
/// ... text ...
///

或者

arduino 复制代码

//!
//!... text ...
//!

如果不想被文档化, 采用下列注释方式

arduino 复制代码

/* ... text ... */
// ... text ...

添加自定义注释

工具 → 选项 → 文本编辑器 → 片段
添加触发词和模板内容
编辑器中输入触发词并确认