在我的 C 程序中,我有一个专门用于选项解析的翻译单元。
由于我需要非常频繁地添加和更改选项,我如何才能仅通过注释代码来自动反射(reflect)这些更改?
换句话说,我必须提供一个人类可读的选项表,并且我想在每次更改代码时更新它。
最佳答案
您在文本正文中添加的任何 doxygen 命令都会显示在函数的详细信息中,因此如果您的所有选项都在一个函数中定义,那将非常简单。如果它们散落在各处,则使用 xrefitem 和别名为您的选项创建一个新页面。
http://www.doxygen.nl/manual/commands.html#cmdxrefitem
在配置中:
ALIASES += "option=\xrefitem options \"Option\" \"Options\""
在代码中:
/// \option Option -b makes it build
然后在 doxygen 输出中,您将有一个选项页面,其中将列出您的所有选项。不过,在将其粘贴到用户文档之前需要对其进行清理,因为它将包含有关在代码中进行注释的位置的信息。
关于c - 使用 Doxygen 的自动选项表生成器,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/23493932/