如何为外部文档注释定义Doxygen的\ref引用目标？

你可以通过两种方式在.dox或.md文件中定义可被\ref引用的目标，来标注无法纳入源码库的外部参考文档：

方法1：使用Doxygen的\anchor命令 #

在专门的参考说明文件（比如references.dox）中添加如下内容：

/*!
 * \anchor MISRA
 * \section MISRA MISRA C++指南
 * 存放位置：本地服务器路径 `//server/docs/MISRA_CPP_2020.pdf`
 * 该文档定义了代码需遵循的编码规范，多处代码实现均参考此指南。
 */

之后在代码注释里直接用\ref MISRA引用，示例：

/**
 * @brief 初始化硬件寄存器
 * @note 寄存器配置遵循 \ref MISRA 中关于类型安全的要求，同时参考硬件说明文档
 */
void init_hw_registers();

方法2：使用Markdown自定义锚点 #

如果用Markdown文件（比如references.md），可以给标题添加自定义锚点：

## MISRA C++指南 {#MISRA}
存放位置：本地服务器路径 `//server/docs/MISRA_CPP_2020.pdf`
该文档定义了代码需遵循的编码规范，多处代码实现均参考此指南。

同样，代码注释里用\ref MISRA即可跳转到这段说明。

注意事项 #

• 确保包含上述定义的.dox或.md文件被添加到Doxygen配置文件（Doxyfile）的INPUT字段中，否则Doxygen无法解析到锚点。
• 若使用Markdown方式，需确认Doxyfile中MARKDOWN_SUPPORT = YES（默认已开启）。

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