如何使用Doxygen仅将特定静态C函数纳入生成的文档？

你提到的重定义static关键字的方法确实不太规范，容易引发宏冲突或者代码可读性问题，其实Doxygen本身就提供了更优雅的方式来实现只文档化特定静态函数的需求，下面给你两种靠谱的方案：

方案一：利用注释+默认配置（推荐） #

这是最简洁规范的做法，不需要修改任何关键字，只需要调整注释和一个基础配置：

• 保持Doxygen配置里的EXTRACT_STATIC = NO（这是默认值，不用额外修改）
• 在包含静态函数的.c文件开头添加/** @file */标记（告诉Doxygen要处理这个文件的内容，否则它可能会忽略文件里的静态函数）
• 给你想要文档化的静态函数加上完整的Doxygen注释块，比如：

  /**
   * @brief 初始化Foo模块的核心函数
   * 这个静态函数负责完成Foo模块的底层初始化工作，仅在当前文件内部调用
   */
  static void foo(void) {
      // 函数实现代码
  }
  

这样设置后，Doxygen只会把带有完整注释的静态函数foo纳入文档，其他没有注释的静态函数会被自动忽略，完全符合你的需求。

方案二：预定义宏区分（进阶场景） #

如果你的项目需要更灵活的控制（比如要在代码里明确标记哪些静态函数需要文档化），可以用Doxygen的预定义宏功能：

• 在Doxygen配置文件里添加PREDEFINED = DOC_STATIC=static
• 在代码里，给需要文档化的静态函数用DOC_STATIC关键字，其他静态函数还是用原生的static：

  /**
   * @brief 这是需要文档化的静态函数bar
   */
  DOC_STATIC void bar(void) {
      // 实现代码
  }
  
  // 这个静态函数不会被文档化
  static void un_doced_func(void) {
      // 实现代码
  }
  

Doxygen在处理时会把DOC_STATIC替换成static，同时识别这个函数并生成文档，而原生static的无注释函数则不会被提取。不过这种方法不如方案一简洁，适合有特殊标记需求的场景。

最后提醒下，之前的宏重定义方法尽量不要用——它会污染全局宏空间，万一其他代码里也有同名的STATIC宏，很容易出现难以排查的编译问题，而且代码的可读性也会大打折扣。

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