让Doxygen和MSVC TODO标签协同工作

Question

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

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

Answer 1

IIRC doxygen 支持javadoc风格的结构命令，即您应该能够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'"

Answer 2

我不知道VS对待这些“TODO”的方式。但是我认为如果它还认识到TODO是一个待办事项，那么有一种简单的方法。在这种情况下，您可能需要查看doxygen documentation for \xref。这允许您创建标记/命令并链接到特殊部分和相关页面。 \ todo或@todo定义为

\xrefitem todo "Todo" "Todo List"

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

\xrefitem TODO "Todo" "Todo List" 

到它。也许这有帮助。