让 Doxygen 和 MSVC TODO 标签一起工作答案

【问题标题】：Getting Doxygen and MSVC TODO tags to work together让 Doxygen 和 MSVC TODO 标签一起工作
【发布时间】：2010-12-01 13:08:14
【问题描述】：

在 doxygen 中，标准的“/// \todo stuff”用于标记待办事项。我的大部分编码都是在 MSVC 中完成的，因此能够方便地查看任务列表中的 TODO。 MSVC 使用“//TODO stuff”作为他们的标签。有什么办法可以让它们一起工作吗？我找到了任务列表的属性窗格并尝试将“\todo”添加到列表中，但它不喜欢“\”字符。我可以让这两者一起工作吗？

编辑：我特别想知道如何在 Visual Studio 10 中执行此操作。

【问题讨论】：

标签： visual-studio visual-studio-2010 visual-c++ doxygen todo

【解决方案1】：

IIRC doxygen 支持 javadoc-style 结构命令，即您应该能够 use @todo and \todo interchangeably，如果 MSVC 接受 @todo 作为任务标记：

结构命令（与所有其他命令一样）命令）以反斜杠 () 开头，如果您愿意，也可以使用 at 符号 (@) JavaDoc 样式，后跟命令名称和一个或多个参数。

另一种选择是使用 FILE_VERSION_FILTER 作为 doxygen 预处理器，提供自定义脚本（或程序），例如如果您在C:\cygwin 中安装了 Cygwin，那么以下内容将很好地工作：

FILE_VERSION_FILTER = "C:\cygwin\bin\sed -e 's:// *TODO:@todo:g'"

【讨论】：

不幸的是，MSVC 2010 表示任务列表令牌的唯一有效字符是字母数字字符、_、$ 和括号。 doxygen 的预处理步骤似乎是唯一的选择......

【解决方案2】：

我不知道 VS 是如何处理这些“TODO”的。但我认为如果它也将 \TODO 识别为待办事项，则有一种简单的方法。在这种情况下，您可能想查看doxygen documentation for \xref。这允许您创建标签/命令并链接到特殊部分和相关页面。 \todo 或@todo 被定义为

\xrefitem todo "Todo" "Todo List"

您现在可以创建自定义“\TODO”或“@TODO”命令的方法是转到您的配置文件或 doxywizard 并添加行

\xrefitem TODO "Todo" "Todo List"

到它。也许这有帮助。

【讨论】：