如何在Doxygen中为函数注释添加对应文件的最新Git提交哈希？

1. 先修正Git命令（关键） #

你之前配置的git log --format='%H' -1会获取仓库全局的最新提交，而非单个文件的。得改成能针对当前文件的命令，在Doxyfile或Doxywizard里更新配置：

FILE_VERSION_FILTER = git log --format='%H' -1 -- "$FILE"

$FILE是Doxygen自带的变量，会自动替换成当前处理的文件名，保证每个文件的哈希都是自身的最新提交值。

2. 在函数注释里直接引用哈希 #

Doxygen 1.9.3支持用\fileversion命令直接调用FILE_VERSION_FILTER拿到的版本值，给目标函数加注释时这么写：

/**
 * @brief 示例功能函数
 * @version \fileversion
 */
void sampleFunction() {
    // 函数逻辑
}

生成文档后，这个函数的版本栏就会自动显示对应文件的Git提交哈希。

备选方案（万一\fileversion不好使） #

要是遇到兼容问题，换预定义宏的方式：

• 先在Doxyfile里添加一行配置：

  PREDEFINED += FILE_GIT_HASH="\fileversion"
  

• 然后在函数注释里使用这个宏：

  /**
   * @brief 示例功能函数
   * @version FILE_GIT_HASH
   */
  void sampleFunction() {
      // 函数逻辑
  }
  

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