使用Doxygen生成Python文档时无类结构的.py文件未被收录

核心问题排查与修复 #

1. 修复配置文件语法错误
   你的配置中FILE_PATTERNS行末尾的反斜杠是多余的，导致后续的RECURSIVE = YES被错误解析为文件模式的一部分，Doxygen无法正确匹配.py文件。
   修正后的配置行：

   FILE_PATTERNS          = *.py
   

2. 调整关键配置项
   在配置文件中添加/修改以下项，确保纯函数文件被正确提取：

   # 明确提取所有函数（EXTRACT_ALL=YES时虽默认生效，但显式设置更稳妥）
   EXTRACT_FUNCTIONS      = YES
   # 优化Python文档输出格式
   OPTIMIZE_OUTPUT_PYTHON = YES
   # 解析Python原生docstring作为文档内容
   PYTHON_DOCSTRING       = YES
   # 不隐藏无文档注释的文件（默认HIDE_UNDOC_FILES=YES，会过滤无注释的纯函数文件）
   HIDE_UNDOC_FILES       = NO
   

额外建议 #

• 若部分文件仍未被收录，可在纯函数文件的开头添加Doxygen文件标记注释，明确告知Doxygen该文件需要被处理：

  /**
   * @file
   * 这是包含纯函数的工具模块
   */
  
  def calculate_discount(price, rate):
      """计算商品折扣价"""
      return price * (1 - rate)
  

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