Skip to content

Comentarios TODO

Los tipos de comentarios que usar

  • TODO: algo faltante que está pendiente por terminar
  • FIXME: corrección pendiente
  • HACK: código que debe ser refactorizado. Por lo general, no se debe agregar a ningún commit
  • OPTIMIZE: código que necesita refactorización para optimizar su funcionamiento
  • BUG: error identificado que no se va a corregir de inmediato. Usado para indicar a otro desarrollador dónde continuar

Cuando se deja uno de estos comentarios, lo ideal es crear issue, y agregar su id en el comentario. Ejemplo:

# TODO: agregar tema pendiente #1234
# FIXME: evitar que salga antes de terminar #2345

Configuración Vs Code

Vs Code tiene extensiones que mejoran el flujo de trabajo con estas etiquetas. Algunas de ellas son:

Todo Tree

Además de resaltar las etiquetas y mostrar un icono, agrega un panel donde se pueden ver todas las etiquetas usadas en el proyecto.

Configuración de ejemplo:

{
  "todo-tree.general.tags": ["BUG", "HACK", "FIXME", "OPTIMIZE", "TODO"],
  "todo-tree.highlights.defaultHighlight": {
    "gutterIcon": true
  },
  "todo-tree.highlights.customHighlight": {
    "TODO": {
      "icon": "checklist",
      "background": "#FFA500",
      "foreground": "#696969",
      "iconColour": "#FFA500"
    },
    "FIXME": {
      "background": "#FF0000",
      "foreground": "#FFF",
      "iconColour": "#FF0000"
    },
    "HACK": {
      "background": "#e29309",
      "foreground": "#FFF",
      "iconColour": "#e29309"
    },
    "OPTIMIZE": {
      "background": "#148a3c",
      "foreground": "#FFF",
      "iconColour": "#148a3c",
      "icon": "clock"
    },
    "BUG": {
      "background": "#FF0000",
      "foreground": "#FFF",
      "iconColour": "#FF0000"
    }
  }
}

VSCODE-TODO-HIGHLIGHT

Resalta palabras claves

Configuración de ejemplo:

{
  "todohighlight.keywords": [
    {
      "text": "BUG",
      "backgroundColor": "#FF0000",
      "color": "#FFF"
    },
    {
      "text": "HACK",
      "backgroundColor": "#e29309",
      "color": "#FFF"
    },
    {
      "text": "FIXME",
      "backgroundColor": "#FF0000",
      "color": "#FFF"
    },
    {
      "text": "OPTIMIZE",
      "backgroundColor": "#148a3c",
      "color": "#FFF"
    },
    {
      "text": "TODO",
      "backgroundColor": "#FFA500",
      "color": "#696969"
    }
  ]
}