A veces programando nos encontramos algún “bug” que no podemos resolver al momento o alguna corrección o funcionalidad que dejamos para más adelante. La forma ideal de anotar estas “incidencias” para que no se nos olviden y poder resolverlas más adelante es, precisamente, usar la funcionalidad de incidencias/issues del Gitea.
Ésta nos permite hacer un seguimiento, poder añadir comentarios, interactuar con otras compas en su resolución o enlazarla con los cambios en el código que finalmente la resuelven, etc.
Pero a veces nos interesa en vez de eso, simplemente escribir algún comentario dentro del código para indicar un punto que falla o algo que queremos cambiar. En este caso, lo mejor es hacerlo siguiendo las convenciones que ya existen, lo que se suele llamar codetags.
El símbolo del comentario con la palabra TODO en mayúsculas, dos puntos y a continuación la descripción. Se suelen usar también otras palabras clave como las que aparecen en la imagen. Pero por ejemplo, Rstudio reconoce las dos primeras y las pinta de un color diferente para que sean fáciles de encontrar.
Además luego se puede hacer una búsqueda en todo el proyecto con la funcionalidad de “Find in Files” (Ctrl+Mays+F) para ver qué nos hemos ido dejando por ahí.
… menuda imagen,… demasiado nos hemos dejado por ahí 🙈