doxygen - Doxygen 可以轻松配置为识别 TODO 和 FIXME 行吗？

Question

我刚刚安装并设置了一个 Doxygen 实例，但开箱即用时，它只能在代码中找到 TODO 标记，当标记在如下块中时:

/**
 * @todo Foo
 */

它似乎没有找到:

// TODO Foo
// FIXME Bar
// @todo Baz

大多数处理解析的 IDE 和错误跟踪器都可以使用它们，是否有一种简单的方法来配置 Doxygen 以查找它们并将它们列为待办事项？

Answer 1

我们可以使用许多示例和方法:

对于带有有效 doxygen 命令的单行注释(例如 \todo )，您可以使用

/// \todo Some (optional) text

注意三个正斜杠，而不是通常的两个。请参阅 special documentation blocks 中第二个列表中的第三点doxygen 文档的部分。这可用于将新的待办事项添加到您的源代码中。

通常可以通过在 Doxygen 配置文件中定义别名来定义自定义标签(如 FIXME )。例如

ALIASES += FIXME="\todo"

这将允许你写 \FIXME在您的源代码和以 \FIXME 为前缀的注释中将包含在最终文档中的待办事项列表中。这里的问题是你必须在别名前加上 \ (或 @) 符号并以三个前导正斜杠开始注释，如果你想离开 FIXME在您的代码中按原样使用 s 不是一种选择。

最后，我认为您正在寻找的另一种方法是使用 INPUT_FILTER 预处理您的源文件。配置文件选项。该选项定义了一个在 doxygen 构建文档之前应用于每个源文件的命令，因此我们可以定义一个命令来替换 TODO 的实例。和 FIXME带有有效的 doxygen 标记。

 INPUT_FILTER = "sed -e 's/\/\/.*FIXME/\/\/\/ \\todo/'"

此过滤器替换 // FIXME 的所有实例(在 // 和 FIXME 之间有任意数量(或没有)空格)和 /// \todo .此替换仅由 doxygen 在内部进行:您的源文件不会在磁盘上修改。

注意:最后一点的灵感来自于问题 Getting doxygen and MSVC TODO tags to work together 的公认答案。 .但是，该答案使用了 FILE_VERSION_FILTER配置选项而不是 INPUT_FILTER .我认为后者( INPUT_FILTER )在这里实际上更合适。另外， sed该答案中使用的命令对我不起作用。