Question

在我的C程序中，我有一个用于选项解析的专用翻译单元。

由于我需要经常添加和更改选项，如何仅通过注释代码自动反映这些更改？

换句话说，我必须发布一个人类可读的选项表，我想在每次更改代码中的内容时更新它。

Answer 1

您在文本正文中添加的任何doxygen命令都会显示在函数的详细信息中，因此如果您在一个函数中定义了所有选项，那么非常简单。如果它们分散，请使用xrefitem和别名为您的选项创建一个新页面。

在配置中：

ALIASES += "option=\xrefitem options \"Option\" \"Options\""

在代码中：

/// \option Option -b makes it build

然后在doxygen输出中，您将有一个选项页面，列出您的所有选项。在粘贴到用户文档之前，它需要清理，因为它将包含有关注释在代码中的位置的信息。