Doxygen引用函数等实体时如何同步展示其对应的描述内容

你当前使用的是Doxygen文档生成工具的\ref标记，该标记默认仅生成指向目标函数的跳转链接，若需要同步展示函数对应的注释内容，可参考以下3种可行方案：

• 方法1：\ref + \copydoc 组合调用
  直接在\ref命令后追加\copydoc命令即可自动提取目标函数的全量注释：

  \ref foo() \copydoc foo()
  

  输出效果为：先展示foo()的跳转链接，紧跟函数对应的全部注释内容，无需手动复制注释文本。
• 方法2：自定义Doxygen别名（长期使用推荐）
  打开你的Doxygen配置文件（Doxyfile），添加如下自定义别名配置：

  ALIASES += "ref_with_desc{1}=\ref \1 \copydoc \1"
  

  后续需要使用「链接+注释」的展示效果时，直接调用自定义命令即可：

  \ref_with_desc foo()
  

  一次配置即可全局复用，无需每次重复编写两条命令。
• 方法3：仅提取简要注释
  如果你只需要展示///对应的简短摘要，不需要参数、返回值等详细注释，可以使用\brief命令搭配\ref：

  \ref foo() \brief foo()
  

  输出仅包含跳转链接和函数的短描述，内容更简洁，适合文档内快速引用的场景。

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