Como siempre es Buena práctica documentar nuestro trabajo, en el desarrollo, el código fuente no es la excepción. Sin embargo, si no se cuenta con las herramientas necesarias, puede ser un trabajo tedioso. Una gran idea (¿introducida en Javadocs™?) fue la de documentar el código fuente al tiempo que se escribía dicho código. Esto ahorraba mucho tiempo a la vez que permitía al mismo programador realizar la documentación. El lenguaje que introdujo esta idea fue Java, con la herramienta Javadocs, utilizando una especie de anotaciones – una palabra seguida del carácter arroba – para realizar esta documentación.
En PHP también existen herramientas similares para generación de código. La que veremos a continuación es una de las más populares: ApiGen, que soporta la mayoría de anotaciones para documentar código fuente. Para más información acerca de las anotaciones soportadas, revise este enlace.
Blog 501 