2009-09-25 15 views
7

In doxygen, lo standard "/// \ todo stuff" viene utilizzato per contrassegnare un elemento todo. Realizzo la maggior parte della mia codifica in MSVC, quindi è utile poter vedere i TODO nella Task List. MSVC utilizza "// TODO stuff" per i loro tag. C'è un modo per farli lavorare insieme? Ho trovato il riquadro delle proprietà per l'elenco delle attività e provo ad aggiungere "\ todo" alla lista, ma non mi piace il carattere "\". Posso far lavorare questi due insieme?Ottenere i tag Doxygen e MSVC TODO per lavorare insieme

Edit: Sono specificamente interessati a scoprire come fare questo in Visual Studio 10.

risposta

8

IIRC Doxygen supporta javadoc in stile comandi strutturali, per esempio, si dovrebbe essere in grado di use @todo and \todo interchangeably, nell'eventualità che MSVC sarà accettare @todo come marcatore compito: comandi

strutturali (come tutte le altre comandi) iniziano con un backslash(), o un a-chiocciola (@), se si preferisce 0.123.Stile JavaDoc, seguito da un comando nome e uno o più parametri.

Un'altra opzione è quella di utilizzareFILE_VERSION_FILTER come preprocessore Doxygen, fornendo uno script personalizzato (o programma), ad esempio, se avete Cygwin installato nel C:\cygwin allora quanto segue funzionerà bene:

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

Sfortunatamente, MSVC 2010 afferma che i soli caratteri validi per un token elenco di attività sono i caratteri alfanumerici, _, $ e parentesi. Una fase di pre-elaborazione per doxygen sembra essere l'unica opzione ... – Dima

1

non so circa il modo in cui tratta questi VS s "todo". Ma penso che ci sia un modo semplice se riconosce anche l'oggetto \ TODO come fare. In questo caso potresti voler dare un'occhiata allo doxygen documentation for \xref. Questo ti permette di creare tag/comandi e link a una sezione speciale e una pagina correlata. \ Todo o @todo è definito come

\xrefitem todo "Todo" "Todo List" 

Che cosa si può fare ora per creare un costume "\ TODO" o "@TODO" comando è andare al vostro file di configurazione o il doxywizard e aggiungere la linea

\xrefitem TODO "Todo" "Todo List" 

ad esso. Forse questo aiuta.

Problemi correlati