¿Qué significa XXX en un comentario? [cerrado]

72

¿Qué quiere decir la gente en general cuando ves XXXen un comentario? De vez en cuando, veo un comentario como este:

# XXX - This widget really should frobulate the whatsit

Por supuesto, puedo decir qué significa el comentario, pero ¿qué significa generalmente el XXX? ¿Está diciendo "Esto es un truco" o tal vez "Quizás deberíamos volver a visitar esto más tarde"? ¿O está diciendo algo completamente diferente?

Jason Baker
fuente
Yo uso qazpersonalmente. Fácil de escribir y en 40 años de codificación nunca ha aparecido naturalmente en mi código, por lo que puedo buscarlo fácilmente. En lugar de FixMe: o ToDo: lo uso para hacks experimentales rápidos que luego puedo revertir fácilmente si no funcionan. Pero mi qazsería no estar comprometidos con control de código fuente, mientras que Fixme: o Tareas: o XXX podría ser.
Mawg
Me di cuenta de que hay muchos comentarios XXX antiguos en la base de código de Meteor ... una especie de comentario continuo sobre sus secretos sucios. ¡Y parece que usan alguna herramienta para eliminarlos automáticamente del código que se envía!
Andy

Respuestas:

68

Lo que XXXrepresenta depende del autor del código. En general, se usa como un marcador para el código que requiere atención.

Sin embargo, esta página web establece un tren de pensamiento algo diferente:

XXX: solía marcar algo que es falso pero funciona

FIXME: solía marcar algo que es falso y roto

Supongo que esto muestra además que su significado no está bien definido y se usa de manera diferente.

Jonathan Khoo
fuente
12
HACKsería una alternativa a XXX.
Richard
1
el enlace está roto :(
Jack
1
FIXME: link broken
onewhaleid
1
HACK no es una alternativa a XXX. El indicador de comentarios XXX tiene una larga historia, y esencialmente significa algo que funciona, pero necesita atención (falso pero funciona).
Brill Pappin
98

Es un código sucio ;)

MattyD
fuente
20
¿Es esta una respuesta divertida o una respuesta divertida y correcta?
koenmetsu
44
oh esos programadores traviesos
aeracode
@koenmetsu divertido y preciso. Está mal , pero funciona lo suficientemente bien por ahora, así que no está del todo mal. "Sucio" es una descripción adecuada para algo que funciona pero que no es del todo correcto (es decir, limpio).
Iiridayn
21

Según Wikipedia : "XXX para advertir a otros programadores de código problemático o erróneo". - que podría extraerse de contenedores de veneno que digan "xxx" en ellos; super vieja escuela

Si se trata de una nota TODO, aquí hay una publicación de blog relacionada llamada TODO o no TODO , que cubre el uso de GREP para ordenar los comentarios por fecha, propietario, etc.

errores
fuente
13

No significa nada. Es solo una secuencia de caracteres que es visualmente distintiva (lo que facilita el escaneo 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 marcador para marcar comentarios que deben ser fácilmente buscables. Por lo general, marca un fragmento de código que debe revisarse.

Jörg W Mittag
fuente
2
También es fácil de encontrar con grep o similar
Zachary K
7

IIRC es una anotación que antecede y tiene un significado similar a las anotaciones TODO o FIXME. Es bastante común en la fuente de vim, por ejemplo.

Rein Henrichs
fuente
6

Es muy probable que sea una secuencia de caracteres que no aparece en el código regular, lo que significa que se puede buscar fácilmente desde una línea de comandos:

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$ 

(ejemplo es para Unix, creo que "findtr" hace lo mismo con Microsoft Windows)


fuente
4

pero, ¿qué significa generalmente el XXX? ¿Está diciendo "Esto es un truco" o tal vez "Quizás deberíamos volver a visitar esto más tarde"? ¿O está diciendo algo completamente diferente?

Cualquiera de los anteriores.

La elección de XXX versus TODO o FIXME o HACK u otra cosa no se rige por ninguna norma o convención. Básicamente, significa lo que sea que la persona que lo puso allí quiso decir. Puede ser obvio ... o puede ser totalmente opaco para usted.


ACTUALIZAR Wikipedia actualmente (30/03/2016) dice:

Dichas etiquetas difieren ampliamente, pero pueden incluir:

  • ...
  • XXX: advierte a otros programadores sobre códigos problemáticos o erróneos

Tenga en cuenta las advertencias claras en el texto original. El XXX podría interpretarse como una alusión al "XXX" que se ve en las botellas de veneno y / o alcohol ilegal en cómics clásicos, dibujos animados, etc.

Stephen C
fuente
2

Es muy probable que sea un marcador que luego se puede encontrar. A diferencia de TODO o FIXME o similares, XXX rara vez se encuentra en una palabra o construcción, por lo que es perfecto para un marcador que se mantendrá solo cuando se busquen los archivos.

Torre
fuente
0

De donde soy originalmente, usamos XXX (y luego YYY, ZZZ) para números que aún no conocemos, por ejemplo: agregue XXX a YYY para encontrar el resultado, luego agregue 10%.

Se origina en ecuaciones en la escuela donde 'x' es la variable desconocida.

Dimitrios Mistriotis
fuente