Primer logotipo de SMC Acabo ahora mismo de terminar de repasar y documentar todos y cada uno de los 94 métodos conque cuenta ya la clase SmcDB de SMC. ¿Recuerdas cuando dije que iba a poner a hacerlo? ¿Y que dije que mientras tanto no haría otra cosa? Lo cierto es que he añadido varias cosas a SMC por el camino, no cumplí con el objetivo que yo mismo me propuse: "no more features".

Pero, en fin, ya está. A lo menos en lo que toca a la clase SmcDB, y, lo que quiero aprender de todo esto es: documenta el código que escribas, antes de escribir nada más. Porque si no lo haces así el código se acumula... y luego cuesta un huevo documentarlo, no por nada, sino sólo porque es una tarea que puede hacerse "pesada".

Sin embargo, documentar no tiene que ser una tarea pesada. Es fundamental, para concretar exactamente qué se supone que hace un determinado método, por ejemplo; viene muy bien para encontrar "cosas raras", para repasar el código fuente. Es necesario documentar, en fin, y por tanto habrá que evitar que se haga pesada esta tarea.

En los comentarios de SMC estoy procurando seguir todo lo que puedo el "estándar" que sigue PhpDoc, de modo que pueda luego generarse "automáticamente" la documentación mediante este estupendo programa. La documentación está orientada al "programador", a mí mismo, y a quien quiera meterse en el código fuente de SMC de alguna manera.

Todavía queda mucho por documentar y mucho por hacer en SMC. Así que seguiré hablando del asunto por aquí, a riesgo de caer pesado. :P