¿Cuál es phpDocumentor?
phpDocumentor 2 es una herramienta que hace posible la generación de la documentación directamente desde el código fuente de PHP. Con esto se puede proporcionar a los consumidores con más información sobre la funcionalidad incrustado dentro de su fuente y no sólo lo que es útil para ellos desde su interfaz de usuario.
Documentación generada por phpDocumentor 2 no pretende ser un reemplazo para la documentación convencional, pero es más bien suplementario, o de referencia, documentation.This demuestra ser útil en las siguientes situaciones ejemplo:
- Conjuntos de bibliotecas o aplicaciones que proporcionan una API, tales como phpDocumentor 2 propia
- Marcos, como Zend Framework o Symfony
- arquitecturas enchufables, como WordPress o PyroCMS
- Y larga ejecución de proyectos complejos, para ayudarle a encontrar la función correcta o método para el trabajo
Análisis de código
phpDocumentor 2 es capaz de extraer información interesante y presentándola en forma de gráficos e informes. Los siguientes son compatibles actualmente:
- Un diagrama de herencia mostrando toda la subclasificación y la implementación de interfaces.
- Informar de errores en la documentación en línea de su código fuente.
- Informes que los elementos marcados como obsoletos.
- Informes donde TODOs se colocan en el código y lo que hay que hacer.
Esta lista sólo crecerá en el futuro para ayudar a determinar dónde invertir sus recursos con el fin de hacer que el código sea más estable y fácil de mantener.
