Обеспечение совместной работы тегов Doxygen и MSVC TODO

В doxygen стандартное «/// \todo stuff» используется для пометки элемента списка дел. Я делаю большую часть своего кода в MSVC, поэтому удобно иметь возможность видеть TODO в списке задач. MSVC использует «//TODO stuff» для своих тегов. Есть ли способ заставить их работать вместе? Я нашел панель свойств для списка задач и попытался добавить «\ todo» в список, но ему не нравится символ «\». Могу ли я заставить эти два работать вместе?

Изменить: мне особенно интересно узнать, как это сделать в Visual Studio 10.


visual-studio visual-studio-2010 visual-c++ doxygen todo
person shadowland    schedule 25.09.2009    source источник

Ответы (2)


arrow_upward
8
arrow_downward

IIRC doxygen поддерживает структурные команды в стиле javadoc, т. е. вы должны иметь возможность используйте @todo и \todo взаимозаменяемо, в случае, если MSVC примет @todo в качестве маркера задачи:

Структурные команды (как и все другие команды) начинаются с обратной косой черты () или знака @, если вы предпочитаете стиль JavaDoc, за которым следует имя команды и один или несколько параметров.

Другой вариант — использовать FILE_VERSION_FILTER в качестве doxygen. препроцессор, предоставляющий пользовательский скрипт (или программу), например если у вас установлен Cygwin в C:\cygwin, то следующее будет работать хорошо:

FILE_VERSION_FILTER = "C:\cygwin\bin\sed -e 's:// *TODO:@todo:g'"
person vladr    schedule 29.06.2010
comment
К сожалению, MSVC 2010 говорит, что единственными допустимыми символами для маркера списка задач являются буквенно-цифровые символы, _, $ и круглые скобки. Шаг предварительной обработки для doxygen кажется единственным вариантом... - person Dima; 29.06.2010

arrow_upward
1
arrow_downward

Я не знаю, как VS относится к этим «TODO». Но я думаю, что есть простой способ, если он также распознает \TODO как задачу. В этом случае вы можете ознакомиться с документацией doxygen для \xref. Это позволяет вам создавать теги/команды и ссылаться на специальный раздел и связанную страницу. \todo или @todo определяется как

\xrefitem todo "Todo" "Todo List"

Что вы можете сделать сейчас, чтобы создать пользовательскую команду «\ TODO» или «@TODO», — это перейти в свой файл конфигурации или doxywizard и добавить строку

\xrefitem TODO "Todo" "Todo List"

к этому. Может быть, это помогает.

person HaMster    schedule 01.12.2012