¿Qué significa la gente en general cuando ves XXX en un comentario? De vez en cuando, veré un comentario como este:
# XXX - This widget really should frobulate the whatsit
Por supuesto, puedo decir lo que significa el comentario, pero ¿qué significa generalmente el XXX? ¿Está diciendo "Esto es un truco" o tal vez "Quizás deberíamos revisar esto más adelante"? ¿O es algo completamente distinto?
Lo que representa XXX , depende del autor del código. En general, se usa como marcador para el código que requiere atención.
Sin embargo, esta página web indica una línea de pensamiento algo diferente:
XXX: se usa para marcar algo que es falso pero funciona
FIXME: se usa para marcar algo que está falso y roto
Supongo que esto demuestra que su significado no está bien definido y se usa de manera diferente.
Es un código sucio ;)
Por Wikipedia : "XXX para advertir a otros programadores sobre código problemático o de guía errónea". - que podrían sacarse de los contenedores de veneno que dicen "xxx" en ellos; super vieja escuela.
Si se trata de una nota de TODO, aquí hay una publicación relacionada del blog llamada, TODO o no TODO , que cubre usando GREP para ordenar los comentarios por fecha, propietario, etc.
No significa nada. Es solo una secuencia de caracteres que es visualmente distintivo (lo que facilita su exploración visual) y es poco probable que aparezca en el código o en los comentarios (lo que facilita la búsqueda programática).
Por lo tanto, se utiliza como un marcador para marcar los comentarios que deben poder buscarse fácilmente. Por lo general, marca un fragmento de código que debe ser revisado.
IIRC es una anotación que precede y tiene un significado similar a las anotaciones TODO o FIXME. Es bastante común en la fuente de vim, por ejemplo.
Es muy probable que sea una secuencia de caracteres que no se produce en el código normal, lo que significa que se puede buscar fácilmente desde una línea de comando:
ravn:tmp ravn$ echo XXXX This is very bad > processor.c
ravn:tmp ravn$ echo XXXX Verify defaults before going in production > main.c
ravn:tmp ravn$ grep -R XXXX .
./main.c:XXXX Verify defaults before going in production
./processor.c:XXXX This is very bad
ravn:tmp ravn$
(el ejemplo es para Unix, creo que "findstr" hace lo mismo en Microsoft Windows)
pero, ¿qué significa generalmente el XXX? ¿Está diciendo "Esto es un truco" o tal vez "Quizás deberíamos revisar esto más adelante"? ¿O es algo completamente distinto?
Cualquiera de los anteriores.
La elección de XXX frente a TODO o FIXME o HACK u otra cosa no se rige por ninguna regla o convención sólida. Básicamente, significa lo que la persona que lo puso quiso decir. Puede ser obvio ... o puede ser totalmente opaco para usted.
ACTUALIZACIÓN Wikipedia actualmente (2016-03-30) dice:
Estas etiquetas difieren ampliamente, pero pueden incluir:
- ...
- XXX: advierte a otros programadores sobre códigos problemáticos o de desvío de ideas
Tenga en cuenta las advertencias claras en el texto original. La XXX podría interpretarse como una alusión a la "XXX" que se ve en botellas de veneno y / o lunas en cómics clásicos, dibujos animados, etc.
Es muy probable que sea un marcador que luego se puede encontrar. A diferencia de TODO o FIXME o similares, XXX se encuentra muy raramente en cualquier palabra o construcción, por lo que es perfecto para un marcador que estará solo cuando se busquen archivos.
De donde soy originalmente usamos XXX (y luego YYY, ZZZ) para los números que aún no conocemos, por ejemplo: agregue XXX a YYY para encontrar el resultado, luego agregue 10%.
Se origina a partir de ecuaciones en la escuela donde 'x' es la variable desconocida.
Lea otras preguntas en las etiquetas coding-standards comments