Doxygen - Ini 作为文本？答案

【问题标题】：Doxygen - Ini as a Text?Doxygen - Ini 作为文本？
【发布时间】：2013-11-26 10:29:28
【问题描述】：

我开始使用 doxygen 进行文档记录，就它而言，它看起来非常简单和有用！
只有一个文件让我头疼，我的 config.ini 。这个文件有不同的cmets、标准等。。我想将它作为“代码”加载，所以页面不会被解释。

我怎样才能做到这一点？

以下操作无效：
; /// @file config.ini
; /// @代码
设置1
设置2
设置3
; /// @endcode

【问题讨论】：

【解决方案1】：

您的问题有点不清楚，但我假设您确实希望在文档中查看 .ini 文件的内容。

对于我认为您需要的内容，我建议使用 @verbatim 而不是 @code。

如果你什么也没看到，那么检查.ini 是否在 doxygen 将解析的文件扩展名列表中？这是 doxyfile 中的设置。

【讨论】：

ini 在文件扩展名列表中并被解析。我想要的是文件树中的 config.ini。当我打开该 ini 的信息时，我希望将 ini 视为它的代码，而不是由 doxygen 解释。换句话说，我需要评论块之间的整个 ini 内容，这是行不通的......
还是有点困惑——我可以把问题分解一下吗： 1. config.ini 在文件树中吗？ 2. 你看到评论区之间的文字了吗？ 3. 它看起来像什么（you 是什么意思 interpreted by doxygen？）它是像文本一样合并，还是像代码一样具有语法颜色，或者...？ 4. 如果你按照建议使用@verbatim，它会改变吗？
1.是的 2. 是的，但解释为带有部分错误 cmets 等的变量。 3. 看看 2 4. 起初它没有 5. 我很愚蠢，逐字逐句是正确的想法，现在可以使用。将“///”更改为 /**，因此 doxygene 将 ini 的内容视为注释。我自己的脚本仍然接受它作为 ini-context :)
@abcNocturn 这个答案的 -15 rep 反接受有什么特别的原因吗？

【解决方案2】：

你可以按如下方式做你想做的事：

定义一个包含 .ini 文件的页面，例如 test.dox，如下所示：

/** @page test_ini test.ini
 *  This is the configuration file:
 *  @verbinclude test.ini
 */

然后将doxygen的配置文件中的EXAMPLE_PATH设置为test.ini所在的目录，FILE_PATTERNS中不要包含.ini文件（所以使用默认）。

【讨论】：