使Doxygen和MSVC TODO标签协同工作 [英] Getting Doxygen and MSVC TODO tags to work together

问题描述

在doxygen中，标准的"///\ todo东西"用于标记待办事项.我在MSVC中进行大部分编码，因此可以在任务列表"中查看TODO. MSVC在其标签中使用"//TODO的东西".有什么办法可以使他们一起工作?我找到了任务"列表的属性窗格，并尝试将"\ todo"添加到列表中，但是它不喜欢"\"字符.我可以让这两个一起工作吗?

In doxygen, the standard "/// \todo stuff" is used to tag a todo item. I do most of my coding in MSVC so it's handy to be able to see the TODO's in the Task List. MSVC uses "//TODO stuff" for their tags. Is there any way to make them work together? I found the properties pane for the Task list and try to add "\todo" to the list, but it doesn't like the "\" character. Can I make these two work together?

我特别想了解如何在Visual Studio 10中执行此操作.

I am specifically interested to find out how to do this in Visual Studio 10.

推荐答案

IIRC doxygen 支持javadoc样式结构命令，即您应该能够

IIRC doxygen supports javadoc-style structural commands, i.e. you should be able to use @todo and \todo interchangeably, in the eventuality that MSVC will accept @todo as a task marker:

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

Structural commands (like all other commands) start with a backslash (), or an at-sign (@) if you prefer JavaDoc style, followed by a command name and one or more parameters.

另一种选择是使用 FILE_VERSION_FILTER 作为doxygen预处理程序，提供自定义脚本(或程序)，例如如果您在C:\cygwin中安装了Cygwin，则可以很好地进行以下操作:

Another option is to use FILE_VERSION_FILTER as a doxygen preprocessor, providing a custom script (or program), e.g. if you have Cygwin installed in C:\cygwin then the following will work nicely:

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

这篇关于使Doxygen和MSVC TODO标签协同工作的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！