2009-09-25 18 views
7

En doxygen, el estándar "/// \ todo lo demás" se utiliza para etiquetar un elemento de tareas pendientes. Hago la mayor parte de mi codificación en MSVC, así que es útil poder ver los TODO en la Lista de tareas. MSVC usa "// TODO stuff" para sus etiquetas. ¿Hay alguna forma de hacer que funcionen juntos? Encontré el panel de propiedades para la lista de tareas e intento agregar "\ todo" a la lista, pero no me gusta el carácter "\". ¿Puedo hacer que estos dos trabajen juntos?Obtener las etiquetas TODO de Doxygen y MSVC para que funcionen juntas

Editar: Estoy especialmente interesado en saber cómo hacer esto en Visual Studio 10.

Respuesta

8

IIRC Doxygen apoya al estilo javadoc comandos estructurales, es decir, usted debería ser capaz de use @todo and \todo interchangeably, en la eventualidad de que MSVC se@todo aceptar como un marcador de tareas: los comandos de

estructurales (como todos los otros comandos ) comenzar con una barra invertida(), o un signo de arroba (@), si lo prefiere estilo JavaDoc, seguido de un comando nombre y uno o más parámetros.

Otra opción es utilizarFILE_VERSION_FILTER como un preprocesador Doxygen, proporcionando un script personalizado (o programa), por ejemplo, si ha instalado Cygwin en C:\cygwin entonces el siguiente trabajo muy bien:

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

Desafortunadamente, MSVC 2010 dice que los únicos caracteres válidos para un token de lista de tareas son los caracteres alfanuméricos, _, $ y paréntesis. Un paso previo al procesamiento de doxygen parece ser la única opción ... – Dima

1

no sé por la forma VS trata estos s "todo". Pero creo que hay una manera fácil si también reconoce \ TODO como una tarea pendiente. En este caso, es posible que desee echar un vistazo a doxygen documentation for \xref. Esto le permite crear etiquetas/comandos y vincular a una sección especial y una página relacionada. \ TODO o @todo se define como

\xrefitem todo "Todo" "Todo List" 

Lo que puede hacer ahora para crear una costumbre "\ TODO" o comando "@TODO" es ir a su archivo de configuración o el doxywizard y añadir la línea

\xrefitem TODO "Todo" "Todo List" 

a él. Tal vez eso ayude.

Cuestiones relacionadas