2009-09-25 10 views
7

W doxygen do oznaczania pozycji todo używane jest standardowe "/// \ todo stuff". Większość koduję w MSVC, więc przydaje się możliwość wyświetlenia TODO na liście zadań. MSVC używa "// TODO stuff" do swoich tagów. Czy jest jakiś sposób, aby zmusić ich do współpracy? Znalazłem okienko właściwości dla listy zadań i próbuję dodać "\ todo" do listy, ale nie podoba mi się znak "\". Czy mogę sprawić, by te dwie prace razem?Uzyskiwanie znaczników Doxygen i MSVC TODO do wspólnej pracy

Edit: Jestem szczególnie zainteresowany, aby dowiedzieć się, jak to zrobić w Visual Studio 10.

Odpowiedz

8

IIRC Doxygen obsługuje javadoc stylu poleceń strukturalnego, tj powinieneś być w stanie use @todo and \todo interchangeably, w tym ewentualność MSVC będzie@todo przyjąć jako markera zadanie: polecenia

strukturalne (jak wszystkich innych poleceń) zacząć (backslash), lub at-znak (@) jeśli wolisz Styl JavaDoc, po którym następuje nazwa polecenia i jeden lub więcej parametrów.

Innym rozwiązaniem jest użycie FILE_VERSION_FILTER jako preprocesor Doxygena, zapewniając scenariusz niestandardową (lub programu), np jeśli Cygwin zainstalowany w C:\cygwin następnie dodaje zadziała ładnie:

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

Niestety, MSVC 2010 twierdzi, że jedynymi poprawnymi znakami dla tokenu listy zadań są znaki alfanumeryczne _, $ i nawiasy. Etap wstępnego przetwarzania dla doxygen wydaje się być jedyną opcją ... – Dima

1

Nie wiem o sposób VS traktuje te „Todo” s. Ale myślę, że jest łatwy sposób, jeśli rozpoznaje \ TODO jako przedmiot do zrobienia. W takim przypadku możesz chcieć rzucić okiem na doxygen documentation for \xref. Pozwala to na tworzenie tagów/poleceń i link do specjalnej sekcji i powiązanej strony. \ Todo lub @todo jest zdefiniowany jako

\xrefitem todo "Todo" "Todo List" 

Co można zrobić teraz, aby utworzyć niestandardowy „\” lub „TODO @TODO” Polecenie to udać się do swojego pliku konfiguracyjnego lub doxywizard i dodaj linię

\xrefitem TODO "Todo" "Todo List" 

do niego. Może to pomaga.

Powiązane problemy