让Doxygen和MSVC的TODO标签一起工作

Question

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

编辑：我特别想知道如何在Visual Studio 10中实现这一点。

- shadowland

Answer 1

我IRC，doxygen支持javadoc风格的结构命令，即您应该能够交替使用@todo和\todo，如果MSVC将接受@todo作为任务标记的话：

结构命令（像所有其他命令一样）以反斜杠()或符号(@)开头，如果您喜欢JavaDoc风格，则后跟命令名称和一个或多个参数。

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

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

- vladr

---

不幸的是，MSVC 2010 表示任务列表标记的唯一有效字符是字母数字字符、下划线、美元符号和括号。似乎预处理 doxygen 是唯一的选择... - Dima

Answer 2

我不知道VS如何处理这些“TODO”。但是如果它也将\TODO识别为待办事项，那么有一个简单的方法。在这种情况下，您可能需要查看{{link1：Doxygen文档中的\xref}}。这允许您创建标签/命令并链接到特定部分和相关页面。 \todo或@todo被定义为

\xrefitem todo "Todo" "Todo List"

现在您可以执行以下操作来创建自定义的"\TODO"或"@TODO"命令：前往您的配置文件或Doxywizard，并添加以下行。

\xrefitem TODO "Todo" "Todo List" 

针对IT方面的问题，也许这可以帮到您。

- HaMster