Entradas

Mostrando entradas de febrero, 2018

Angular y generación automática de documentación de código.

Imagen
    Hoy vamos a ver como generar la documentación del código de un proyecto Angular. Para esto hay que utilizar una herramienta llamada "compodoc". La página web de este proyecto se encuentra en   https://compodoc.github.io/compodoc/      Como cualquier otro paquete de un proyecto Angular, lo instalaremos como paquete npm. Si buscamos en el repositorio npmjs.com, lo encontraremos en https://www.npmjs.com/package/@compodoc/compodoc      Y en https://compodoc.github.io/website/guides/installation.html   nos explican como instalarlo:   Lo mejor es instalarlo en local, mediante la linea:  npm install --save-dev @compodoc/compodoc Una vez instalado, hay que configurar como lo queremos ejecutar. Para esto, en el fichero package.json de nuestro proyecto, en la sección de script. Por ejemplo, en mi proyecto de prueba tengo:  En mi caso, no solo indico que se cree la documentación ...