Ir al contenido principal

Entradas

Mostrando entradas de mayo, 2022

miframe-docsimple: Documentación siempre en línea

Uno de los grandes dolores de cabeza que tuve al programar fue el no poder acceder en línea a la documentación del código y como tal, poca importancia se le dio a la documentación efectiva del mismo. Como resultado, la revisión de código resultaba un completo martirio cuando no recordabas los detalles de alguna clase o función o no tenías a mano al programador que lo escribió para explicarlo. DocSimple es una clase PHP que se encarga de leer un script e intenta recuperar la documentación del mismo, siempre que esta se haga siguiendo las directrices del modelo Javadoc, adaptado según se describe en la página de la librería phpDocumentor . Por ejemplo: /** * Primera línea es un resumen de mifunction_php. * A continuación la descripción. Cada párrafo termina en punto o con una * línea en blanco. * @param string $argument1 Esta es la descripción del primer argumento. * @return string Texto de salida. */ function mifunction_php(string $argument1) { … return $text; } Aunque por defe

Presentación

Como programador, en más de una oportunidad he tenido que escribir módulos o librerías de funciones que he podido utilizar en más de un programa o proyecto diferente, en tanto que otras se han perdido entre tantos archivos acumulados en el computador y los he escrito de nuevo cuando los he vuelto a necesitar. Muchas de estas librerías seguro han tenido correcciones y mejoras de comportamiento con el paso del tiempo y las mejoras en los lenguajes usados (mayormente PHP ), mejoras que se ven reflejadas en proyectos nuevos en tanto que los viejos quedan como estaban. Vale mencionar también esos programas pequeños escritos para resolver alguna necesidad puntual que luego quedan en desuso ya sea por obsoletos o porque simplemente no recordaba que los tenía y (en este último escenario) termino escribiéndolos otra vez cuando la necesidad se presenta de nuevo. Así las cosas, busqué un organizador de código personal, que pudiera tener en mi computador y me ayudara con este caos programático. Co