在 doxygen 中,标准的“/// \todo stuff”用于标记待办事项。我的大部分编码都是在 MSVC 中完成的,因此能够方便地查看任务列表中的 TODO。MSVC 使用“//TODO stuff”作为他们的标签。有什么办法可以让它们一起工作吗?我找到了任务列表的属性窗格并尝试将“\todo”添加到列表中,但它不喜欢“\”字符。我可以让这两个一起工作吗?
编辑:我特别有兴趣了解如何在 Visual Studio 10 中执行此操作。
在 doxygen 中,标准的“/// \todo stuff”用于标记待办事项。我的大部分编码都是在 MSVC 中完成的,因此能够方便地查看任务列表中的 TODO。MSVC 使用“//TODO stuff”作为他们的标签。有什么办法可以让它们一起工作吗?我找到了任务列表的属性窗格并尝试将“\todo”添加到列表中,但它不喜欢“\”字符。我可以让这两个一起工作吗?
编辑:我特别有兴趣了解如何在 Visual Studio 10 中执行此操作。
IIRC doxygen支持 javadoc 样式的结构命令,即您应该能够使用@todo
和\todo
互换,以防 MSVC接受作为任务标记:@todo
结构命令(与所有其他命令一样)以反斜杠 () 开头,如果您更喜欢 JavaDoc 样式,则以 at 符号 (@) 开头,后跟命令名称和一个或多个参数。
另一种选择是FILE_VERSION_FILTER
用作 doxygen 预处理器,提供自定义脚本(或程序),例如,如果您安装了 Cygwin,C:\cygwin
那么以下将很好地工作:
FILE_VERSION_FILTER = "C:\cygwin\bin\sed -e 's:// *TODO:@todo:g'"
我不知道 VS 对待这些“TODO”的方式。但我认为如果它也将 \TODO 识别为待办事项,则有一种简单的方法。在这种情况下,您可能想查看\xref 的 doxygen 文档。这允许您创建标签/命令并链接到特殊部分和相关页面。\todo 或@todo 被定义为
\xrefitem todo "Todo" "Todo List"
您现在可以做的创建自定义“\TODO”或“@TODO”命令是转到您的配置文件或 doxywizard 并添加行
\xrefitem TODO "Todo" "Todo List"
给它。也许这有帮助。