如何让Doxygen自动标记含Q_OBJECT的Qt类支持信号与槽？

方法一：通过PREDEFINED直接替换Q_OBJECT为类级注释 #

无需额外脚本，仅通过Doxygen配置即可实现需求：

1. 打开你的Doxygen配置文件（通常为Doxyfile）
2. 设置以下配置项：

   # 启用宏展开功能
   MACRO_EXPANSION = YES
   # 仅展开PREDEFINED中指定的宏
   EXPAND_ONLY_PREDEF = YES
   # 将Q_OBJECT替换为类级注释块，用@note标记信号槽支持
   PREDEFINED = Q_OBJECT=/** @note 该类支持Qt信号与槽机制 */
   

3. 重新生成文档，所有包含Q_OBJECT宏的类，其文档会自动追加这条注释。

注意：若之前替换后注释被关联到构造函数等后续成员，需确保注释块使用/** ... */格式，且避免使用@brief这类会绑定到后续元素的命令，改用@note、@par这类通用注释命令，Doxygen会将其归为类文档的一部分。

方法二：结合ALIASES与PREDEFINED实现可复用标记 #

如果需要统一管理注释内容，可通过别名定义实现复用：

1. 在Doxyfile中添加别名规则：

   ALIASES += "qt_signal_support=@note 该类基于Qt框架实现，支持信号与槽机制"
   

2. 配置宏展开与替换规则：

   MACRO_EXPANSION = YES
   EXPAND_ONLY_PREDEF = YES
   PREDEFINED = Q_OBJECT=/** @qt_signal_support */
   

3. 重新生成文档，效果与方法一一致，后续修改注释内容仅需调整ALIASES即可。

验证示例 #

以测试类为例：

#include <QObject>

/**
 * @brief 测试类
 * 这是一个继承QObject的测试类
 */
class TestClass : public QObject
{
    Q_OBJECT
public:
    explicit TestClass(QObject *parent = nullptr);
};

生成的文档中，TestClass的类说明会自动追加信号槽支持的标记，无需手动修改类注释。

内容的提问来源于stack exchange，提问作者cancech