traductor traduccion meaning ingles google frances comment anime comments

traduccion - comments traductor google



¿Cuál es el significado de#XXX en los comentarios del código? (10)

He visto mucho esto en el código, incluso vim lo marca como un caso especial. #TODO y #FIXME son otros dos marcadores de corrección vim destacados pero ¿qué significa #XXX ?

Algunas notas de una propuesta de mejora de Python de junio de 2005 que fue rechazada .

Elegir entre FIXME y XXX es difícil.
XXX parece ser más común, pero mucho menos descriptivo.
Además, XXX es un marcador de posición útil en una pieza de código
teniendo un valor que es desconocido.

Por FIXME tanto, FIXME es la ortografía preferida.
Sun dice que XXX y FIXME son ligeramente diferentes, dando a XXX mayor gravedad.
Sin embargo, con décadas de caos en este tema, y ​​demasiados millones de
desarrolladores que no serán influenciados por Sun, es fácil llamarlos correctamente sinónimos.

El PEP comienza con,

Este PEP ha sido rechazado. Si bien la comunidad puede estar interesada,
no hay ningún deseo de hacer que la biblioteca estándar se ajuste a este estándar.

...

¿Qué son Codetags?

Los programadores utilizan ampliamente convenciones de marcado de comentarios de código ad-hoc para servir como recordatorios de secciones de código que necesitan una inspección o revisión más cercana. Los ejemplos de marcado incluyen FIXME , TODO , XXX , BUG , pero hay muchos más en uso en el software existente. Tal marcado se denominará en lo sucesivo como etiquetas de códigos . Estas etiquetas de códigos pueden aparecer en el código de la aplicación, pruebas unitarias, scripts, documentación general o cuando corresponda.

El PEP es una lectura interesante.

Creo que mientras FIXME es para el desarrollador, y HACK es para el mantenedor, XXX es para el usuario.

Por ejemplo, si ignora el XXX y llama a esta función en otro lugar, sin entender cómo funciona, puede suceder algo inesperado y la persona que trata este problema no estará contento (al menos, el que agregó el XXX cree). Puede pensar que el problema desaparecerá si no usa esta función.

Pero para FIXME , se sentirá digno de solo arreglar el código para que funcione. Y para HACK , es posible que no tenga una mejor opción, incluso si no lo usa.

Si escribió XXX en su propio código y alguien lo usó, puede sentirse infeliz por razones como que reescribió por completo ese código, y luego se comporta de maneras completamente diferentes, y usted rompió el código de otra persona. Pero si dejó un FIXME o TODO lugar, no le importará demasiado.

De (antiguo) convenciones de código Java :

Usa XXX en un comentario para marcar algo que es falso pero funciona. Use FIXME para marcar algo que es falso y roto.

Eche un vistazo a PEP350 . Explica todo TODO , XXX , etc. Lo uso todos los días cuando no puedo recordar exactamente lo que significa una de las etiquetas de código.

Un marcador de posición, generalmente implica que el código al que se refiere es:

  • Feo
  • De miedo
  • magia

o peor.

Uso XXX porque es más fácil escribir que TODO .

XXX es para cuando tienes prisa y volverás a esto tú mismo.

TODO es para cuando tiene que pasárselo a otra persona.

XXX es la abreviatura de advertencia que es ligeramente diferente de NOTE pero bastante similar a HACK. Puede ser un error en una biblioteca / código de un tercero que se está utilizando y el código con // XXX: indica que es una solución debido a un error en el código de un tercero o podría significar "precaución" para alguien que busca / modifica el código para indicar por qué algo se hace de una cierta manera que de otra manera puede parecer incorrecta / poco elegante al primer vistazo. HACK es un término genérico que significa una solución para un problema que podría estar presente en su propia base de código o en una biblioteca de terceros.

XXX en un comentario suele ser un aviso. Podría ser:

  • Algo que no se implementa completamente correctamente.
  • Algo que debería arreglarse más adelante.
  • Destacando un posible punto problemático.
  • Algo de lo que no estás seguro, una pregunta.

A menudo he preferido una etiqueta más descriptiva como FIXME o TODO o HACK . XXX menudo se usa como una trampa para todo lo anterior.

La búsqueda de ''XXX'' en la referencia cruzada del código de FreeBSD es un buen ejemplo de muchos de los usos. Hay miles...

  • NOTE : Descripción de cómo funciona el código (cuando no es evidente).
  • XXX : Advertencia sobre posibles dificultades, se puede utilizar como NOTE:XXX:
  • HACK : código no muy bien escrito o mal formado para eludir un problema / error. Debe usarse como HACK:FIXME:
  • FIXME : Esto funciona, más o menos, pero podría hacerse mejor. (por lo general, código escrito con prisa que necesita una nueva redacción).
  • BUG : hay un problema aquí.
  • TODO : No hay problema, pero el código adicional debe escribirse, generalmente cuando se saltea algo.

Al menos así me enseñaron estas etiquetas. Básicamente, los dos primeros ( NOTE y XXX ) se utilizan para información y no se requiere ninguna acción. Mientras que los últimos tres ( FIXME , BUG y TODO ) requieren acción. HACK está en algún punto intermedio (¿y casi nunca usado, creo?).