¿Por qué todos escriben comentarios de tareas en mayúsculas? [cerrado]
9
Estoy haciendo lo mismo. Cuando hay algo "que hacer" en mi código, escribo //TODO .... Pero tengo curiosidad por saber cuándo comenzó esto y si hay una razón para escribir "tareas pendientes" en mayúsculas.
Porque realmente lo SIGNIFICA (simplemente nunca lo hacemos)
Anthony Pegram
3
por lo que los editores pueden marcarlos y dejar que se busca a través de ellos (lista de tareas del Eclipse por ejemplo)
monstruo de trinquete
66
Como en realidad no podía poner el texto en negrita dentro del código, necesitaba alguna forma de destacar las cosas importantes. Por lo tanto ...
Karlson
44
¿Por qué eso importa?
Torre
3
Escribo//todo:...
Bћовић
Respuestas:
23
Además, es genial tener una manera de buscar fácilmente las secciones de código que pasó por alto y a las que desea volver. Puede hacer una búsqueda entre mayúsculas y minúsculas para "TODO" para encontrar inmediatamente lo que omitió antes.
"todo" (minúscula) podría ser parte de una palabra / función / variable más grande, pero "TODO" (mayúscula) probablemente no lo sea.
También permite a los editores resaltar esto. gedit lo hace, por ejemplo, y solo lo hace para todas las mayúsculas TODO. Cualquiera sea la razón, es suficiente incentivo para que lo escriba en mayúsculas.
44
@delnan: Eso es una tautología. Se hizo para sobresalir, por lo que la gente lo usó, por lo que alguien agregó el resaltado de sintaxis en vim para destacar más, por lo que la gente lo usa para destacar. La gente no lo usa porque el editor lo hace destacar, lo usan porque es común hacerlo y, por lo tanto, el editor lo hace destacar. Puede hacer que cualquier cosa se destaque en vim simplemente cambie el resaltado de sintaxis de manera apropiada, es igual de fácil tododestacar, pero no tiene mucho sentido ya que la convención es usar TODO.
Martin York
1
@LokiAstari: Como dije, por mi parte lo escribo en mayúsculas porque más editores resaltan eso de forma predeterminada. Pero tal vez soy una excepción: bastante joven (por lo que no podría haberlo hecho antes de que los editores lo admitieran) y (lamentablemente) demasiado como un holgazán y perezoso para ajustar el resaltado de sintaxis manualmente.
También es bueno para el pobre tipo que necesita limpiar después de usted, y para cualquiera que necesite revisar su código antes de que esté completo. Pueden ver de un vistazo lo que aún no se ha hecho debido a esta convención.
sq33G
2
He encontrado TODO en mayúsculas y minúsculas dentro de un nombre de variable como filesToDownload. Por supuesto, la búsqueda de "solo palabras completas" soluciona ese problema.
dan04
8
Tengo curiosidad por saber cuándo comenzó esto y si hay una razón para escribir tareas pendientes todo el capital?
La idea con comentarios como TODO y FIXME es hacer que sobresalgan. Por lo general, no desea enviar código que tenga dichos marcadores en el código: marcan las cosas que deben hacerse antes de que el proyecto pueda considerarse completo. El uso de ALL CAPS los hace un poco más fáciles de detectar, siempre que no use ALL CAPS para muchas otras cosas en su código también.
Tanto Eclipse como Visual Studio tienen funciones de Lista de tareas que le brindan automáticamente listas de líneas de comentarios que tienen TODO en ellas.
Visual Studio comenzó a hacer // TODO: comentarios cuando agregó por primera vez los generadores de código para material repetitivo de MFC. Esa fue la versión 2.0, iirc.
mjfgates
al menos para Visual Studio, esta búsqueda no distingue entre mayúsculas y minúsculas; también incluirá // todo foo en la lista de tareas
jk.
4
Solo me destaca y es fácil de atrapar ... ¡nada complicado!
eso y es fácil de encontrar a través de grep o similar
Zachary K
@ ZacharyK: ¡Exactamente!
Dinámico
1
Llama la atención sobre el hecho de que existe un todo.
Es importante que sea obvio todo el tiempo que alguien necesita volver al código. Los detalles solo deben ser conocidos por la persona que regresa para abordar cualquier problema.
Otros editores tienen funciones de búsqueda y puede buscar fácilmente todo .
Karlson
Excepto 'todo' podría aparecer en otra cosa, como un nombre de variable, u otro texto del comentario ...
sevenseacat
1
vi distingue entre mayúsculas y minúsculas. Dado que las mayúsculas se usan con moderación en la mayoría de los idiomas modernos (en cosas como las constantes con nombre), la búsqueda tiene una alta probabilidad de éxito.
ncmathsadist
1
Algunos editores solo resaltan elementos TODO en mayúsculas, por lo que es más seguro usar siempre mayúsculas.
Visualmente, TODAS LAS TAPAS se destacan, pero no son muy legibles. Al leer el código escanean como un bloque de un tamaño particular. Realmente no importa cuáles sean las letras. Simplemente se destacan y se pueden ver muy rápidamente. Una vez que haya estado trabajando con las etiquetas por un tiempo, su cerebro reconocerá la palabra por su forma.
Desde el punto de vista de las herramientas (IDE / Editor), la búsqueda entre mayúsculas y minúsculas tendrá una tasa muy baja de falsos positivos en todas las versiones de mayúsculas. En algunos estilos de codificación existe un pequeño riesgo de que una constante coincida. La búsqueda de palabras enteras entre mayúsculas y minúsculas hace que los falsos positivos sean aún menos probables.
Una vez que la herramienta lo muestra en la pantalla, el formato dice claramente mira AQUÍ. Una vez que esté enfocado en la ubicación, la parte legible será el comentario relacionado.
//todo:...Respuestas:
Además, es genial tener una manera de buscar fácilmente las secciones de código que pasó por alto y a las que desea volver. Puede hacer una búsqueda entre mayúsculas y minúsculas para "TODO" para encontrar inmediatamente lo que omitió antes.
"todo" (minúscula) podría ser parte de una palabra / función / variable más grande, pero "TODO" (mayúscula) probablemente no lo sea.
fuente
TODO. Cualquiera sea la razón, es suficiente incentivo para que lo escriba en mayúsculas.tododestacar, pero no tiene mucho sentido ya que la convención es usar TODO.filesToDownload. Por supuesto, la búsqueda de "solo palabras completas" soluciona ese problema.La idea con comentarios como TODO y FIXME es hacer que sobresalgan. Por lo general, no desea enviar código que tenga dichos marcadores en el código: marcan las cosas que deben hacerse antes de que el proyecto pueda considerarse completo. El uso de ALL CAPS los hace un poco más fáciles de detectar, siempre que no use ALL CAPS para muchas otras cosas en su código también.
fuente
Tanto Eclipse como Visual Studio tienen funciones de Lista de tareas que le brindan automáticamente listas de líneas de comentarios que tienen TODO en ellas.
fuente
Solo me destaca y es fácil de atrapar ... ¡nada complicado!
fuente
Llama la atención sobre el hecho de que existe un todo.
Es importante que sea obvio todo el tiempo que alguien necesita volver al código. Los detalles solo deben ser conocidos por la persona que regresa para abordar cualquier problema.
fuente
Si eres un usuario vi usa:
Te llevará allí muy rápido.
fuente
Algunos editores solo resaltan elementos TODO en mayúsculas, por lo que es más seguro usar siempre mayúsculas.
fuente
Visualmente, TODAS LAS TAPAS se destacan, pero no son muy legibles. Al leer el código escanean como un bloque de un tamaño particular. Realmente no importa cuáles sean las letras. Simplemente se destacan y se pueden ver muy rápidamente. Una vez que haya estado trabajando con las etiquetas por un tiempo, su cerebro reconocerá la palabra por su forma.
Desde el punto de vista de las herramientas (IDE / Editor), la búsqueda entre mayúsculas y minúsculas tendrá una tasa muy baja de falsos positivos en todas las versiones de mayúsculas. En algunos estilos de codificación existe un pequeño riesgo de que una constante coincida. La búsqueda de palabras enteras entre mayúsculas y minúsculas hace que los falsos positivos sean aún menos probables.
Una vez que la herramienta lo muestra en la pantalla, el formato dice claramente mira AQUÍ. Una vez que esté enfocado en la ubicación, la parte legible será el comentario relacionado.
fuente