2012-03-06 12 views
31

Así que recientemente descubrí el comentario TODO. Para aquellos de ustedes que no saben, la mayoría de los IDE modernos reconocerán esta palabra en un comentario y marcarán la línea de comentario con un color diferente, por lo que se destaca.IDE comment keywords

EG.

//Need to talk to Bill about refactoring this code 

//TODO:Need to talk to Bill about refactoring this code 

Usted puede notar en el IDE es como Eclipse o Rubymine resaltar el comentario TODO y algunas otras características agradables que ver con ello.

Mi pregunta es: ¿Qué otras palabras clave hay como TODO? Parece una forma mucho mejor de comunicarse con los desarrolladores a través de comentarios y una característica que debería ser un poco más conocida en IDE. Su propósito es ayudar con el desarrollo después de todo ..

+3

'FIXME:' funciona de manera muy similar a 'TODO:' en vim. No es exactamente un IDE, pero aún ... :) – cHao

+1

Puede confirmar que FIXME también funciona en eclipse. Suena bien en realidad. Eso es 2: D – OVERTONE

+1

Sólo una pequeña nota al margen: deje el ':' desde el final de las etiquetas de la tarea. Muchas herramientas las agregan después de la definición, que es un tipo de ruido después (especialmente si algunos de los desarrolladores lo están usando, algunos de ellos no; por ejemplo, confunde un poco la * Vista de tareas * en versiones anteriores de Eclipse). – rlegendi

Respuesta

52

Puedo hablar de Eclipse, puede personalizarlo.

Haga clic en Ventana -> Preferencias y buscar Generales -> Editores -> Structured editores de texto -> etiquetas de tareas, o para Java -> Compilador - etiquetas> Tarea (que podría haber alguna adicional aquellos como JavaScript, PHP, Statet, etc.)

TODO, FIXME, XXX 

utilizo algunos adicionales como:

CHECKME, DOCME, TESTME, PENDING 

personalmente me gusta a U se las etiquetas DISCUSS/REVIEW solo para asegurarme de hablar sobre algún problema con alguien durante una revisión de código o programación de par (por ejemplo, no he entendido mal la especificación de cómo algo debería funcionar, etc.).

También puede establecer las prioridades asignadas a las diferentes etiquetas de tareas allí también.

+1

Agregué ASSUMES para capturar condiciones previas no obvias. – rimsky

8

Estos se conocen como task tags. En Eclipse son TODO, FIXME y XXX.

Sin embargo, Eclipse le permite modificar la lista disponible de etiquetas de tareas. Ir a preferences>Java>Compiler>Task Tags

aquí puede modificar la lista disponible de las etiquetas de trabajo, cambiar su prioridad, y decidir si las etiquetas de tareas deben ser mayúsculas y minúsculas o no.

1

Los patrones como TODO, FIXME son predeterminados en NetBeans como palabras clave pendientes. También puede agregar cualquier palabra clave que desee en Herramientas> Opciones> Varios> Tareas.

+0

Soy consciente de esto. Solo buscaba una lista de los valores generalmente aceptados o predeterminados en el indstry – OVERTONE

1

para activar/desactivar el uso formateador de código: // @formatter: // en @formatter: off

0

Para añadir etiquetas personalizadas en TODO IntelliJ vaya a:

Preferencias> Editor > TODO

1

En Eclipse Oxygen 4.7.2 para C/C++, las etiquetas de tareas se configuran en Windows -> Preferencias -> C/C++ -> Etiquetas de tareas.

También puede habilitar la búsqueda de etiquetas de tareas como @rlegendi answer.