如何正确使用Doxygen的\fileinfo命令指定选项？

问题核心 #

使用Doxygen的@fileinfo命令时，按照文档给出的\fileinfo['{'option'}']语法编写后，生成的HTML页面中选项部分未被解析，仍保留原符号组合；尝试多种语法变体均无法正确获取目标文件的目录、文件名等信息。

正确语法 #

实际使用@fileinfo时，无需额外的引号或转义字符，直接用大括号包裹选项名称即可，格式为：

@fileinfo{选项名}

常用选项示例 #

将mainpage.txt中的代码修改为如下形式，即可正确解析：

/**
  @mainpage Main page
  @page My test main page
  所在目录：@fileinfo{directory}
  文件名：@fileinfo{filename}
  文件扩展名：@fileinfo{extension}
  完整路径：@fileinfo{fullname}
*/

对应的输出效果：

• @fileinfo{directory}：输出文件所在目录路径（如C:/dev/hello-world/doc）
• @fileinfo{filename}：输出不带路径的文件名（如mainpage.txt）
• @fileinfo{extension}：输出文件扩展名（如txt）
• @fileinfo{fullname}：输出完整带路径的文件名（与@fileinfo不加选项的默认输出一致）

错误原因说明 #

文档中给出的\fileinfo['{'option'}']是语法说明的转义写法，用于在文档中区分命令语法和普通字符，并非实际使用时的写法。实际编写注释时，直接使用@fileinfo{选项名}即可被Doxygen正确解析。

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