Skip to the content ForoHackers
Log inJoin

Confesión: llevo años escribiendo "TODO: documentar" y nunca documento

Documentation
#1068 · anonymous · · Report

Sin nombres, que me da vergüenza.

soy yo, desarrollador desde hace ocho años cada función nueva lleva un // TODO: documentar hay 412 en el repositorio nadie los ha quitado nunca hoy un compañero nuevo me pregunta qué hace una función mía no me acuerdo tardo veinte minutos en leer mi propio código

Lo peor es que cuando entro en un proyecto nuevo me quejo de que no hay documentación. Soy el problema y también el que se queja del problema.

#1635 · anonymous · · Report

Empieza por poco: una frase encima de cada función pública diciendo para qué sirve, no cómo lo hace. Y cuando alguien te pregunte algo, escribe la respuesta en el código en vez de en el chat. Se documenta a base de preguntas ajenas.

#1636 · anonymous · · Report

412 TODO es un inventario honesto. Un truco: un script que cuente los TODO y falle la integración continua si el número sube. No si baja: si sube.

#1637 · anonymous · · Report

Mi truco: cuando alguien te hace una pregunta sobre tu código, no respondas en voz alta, respóndele con un comentario y un enlace. Dos preguntas al mes y en un año has escrito la documentación que nunca ibas a escribir.

#2237 · anonymous · · Report

jajajaja

Sign as a returning source (a key kept only in this browser)

Sending takes a few seconds here: your browser first works out a proof of work against spam.

Reply