如何配置Doxygen对自定义的文件头必填字段缺失生成告警？

可以通过Doxygen原生配置实现该需求，具体操作如下：

操作步骤 #

1. 确认Doxygen版本 #

首先确保你使用的Doxygen版本 >= 1.8.18，该版本首次加入了必填文件字段的原生支持。如果版本更低，可以升级Doxygen，或者在Jenkins流水线中新增前置脚本检查文件头字段。

2. 修改Doxyfile配置 #

找到你的Doxygen生成配置文件（通常名为Doxyfile），修改以下配置项：

• 开启文档错误告警总开关：

  WARN_IF_UNDOCUMENTED = YES
  WARN_IF_DOC_ERROR = YES
  

• 配置文件头必填字段，直接把你要求的标签列入即可：

  REQUIRED_FILE_FIELDS = file brief copyright authors date
  

• （可选，适配CI流水线）如果要让缺失字段的告警直接阻塞流水线，开启告警转错误配置：

  WARN_AS_ERROR = YES
  

效果验证 #

配置完成后运行Doxygen，只要任意源文件缺失指定的头注释字段，就会输出你需要的格式的告警，例如：

error: Required command @copyright is missing for file foo.cpp

如果开启了WARN_AS_ERROR，Doxygen会返回非0退出码，Jenkins会自动识别为步骤失败，终止流水线运行。

低版本Doxygen兼容方案 #

如果无法升级Doxygen到1.8.18及以上版本，可以在Jenkins的Doxygen执行步骤前新增一段简单的检查脚本，遍历所有C/C++源文件，检查每个文件头注释中是否包含所有必填的@标签，缺失则输出告警并返回非0退出码即可。

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