shell - 如何在 doxygen 文档中嵌入 shell 片段

Question

安装我的包时，用户应该在某些时候输入

./wand-new "`cat wandcfg_install.spell`"

或者调用任何配置文件。如果我将这一行放在\code ...\endcode 中，doxygen 认为它是 C++ 或...无论如何，“new”这个词被视为关键字。如何以语义正确的方式避免这种情况？

我认为\verbatim 被取消资格，因为它实际上是代码，对吧？

(我想答案是戳 Dimitri 应该在代码块中添加对更多语言的支持，比如 LaTeX 列表包，或者至少同时在代码中添加一个 disableparse 选项)

Answer 1

Doxygen，截至 2017 年 7 月，不正式支持记录 Shell/Bash 脚本语言，甚至不支持 extension .有一个名为 bash-doxygen 的非官方过滤器.设置简单:只需一个文件下载和三个标志调整:

编辑Doxyfile将 shell 文件映射到 C 解析器:EXTENSION_MAPPING = sh=C

将您的 shell 脚本文件名模式设置为 Doxygen 输入，例如
例如:FILE_PATTERNS = *.sh

提及doxygen-bash.sed在 INTPUT_FILTER或者FILTER_PATTERN你的 Doxyfile 的指令。如果 doxygen-bash.sed在
您的 $PATH ，那么您可以按原样调用它，否则使用 sed -n -f /path/to/doxygen-bash.sed -- .

请注意，由于它使用 C 语言解析，因此存在一些限制，如 bash-doxygen 的主 README 页面中所述。 ，其中之一，至少在我的测试中， \code {.sh}识别 shell 语法，但代码块中的所有行都以星号 ( * ) 开头，显然是要求所有 Doxygen 文档部分的行都以双哈希 ( ## ) 开头的副作用。