Doxygen添加\example后函数文档丢失问题求助

这不是Doxygen的默认行为，是配置或命令使用方式有误导致的，以下是具体修正方案：

1. 修正配置文件的路径设置 #

不要将示例文件目录加入INPUT>EXCLUDE列表：

• EXAMPLE_PATH的作用是告诉Doxygen去哪里找示例文件，不需要将该路径加入EXCLUDE——除非你不希望示例文件出现在全局的“示例”分类页面，但这会影响函数文档中示例的正常解析。
• 确保EXAMPLE_PATH指向的目录正确，且示例文件存在于该路径下。

2. 调整函数注释中\example命令的使用方式 #

• 确保\example命令放在函数注释的末尾，不要插入到\brief、\param、\return、\exception等命令中间，避免打断Doxygen对原有文档项的解析：

  /**
   * \brief 获取当前关联的字符串
   * \param[in] id 目标字符串的唯一标识ID
   * \return 返回对应ID的字符串内容
   * \exception std::invalid_argument 当输入ID不在有效范围内时抛出此异常
   * \example{lineno} GetCurrentString_Example.cpp
   * 本示例演示了如何安全调用GetCurrentString函数，包含异常处理逻辑：
   */
  std::string GetCurrentString(int id);
  

• 如果使用{lineno}参数后仍有问题，可以先尝试去掉该参数，使用普通的\example GetCurrentString_Example.cpp测试，确认原有文档是否恢复，再逐步添加行号显示功能。

3. 检查Doxygen核心配置项 #

确保以下配置项处于启用状态（默认均为YES）：

• SHOW_EXAMPLES = YES：控制是否在文档中显示示例内容
• EXAMPLE_RECURSIVE = YES：如果示例文件在子目录中，开启此选项让Doxygen递归查找

4. 验证示例文件的格式 #

示例文件GetCurrentString_Example.cpp不需要特殊注释，只要是合法的C++代码即可，Doxygen会自动解析并高亮显示。如果示例文件有语法错误，可能会间接影响函数文档的解析，但Doxygen通常会给出警告，你可以检查生成日志确认。

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