Menu

Compodoc - Documentación en Ionic.

ionic - February 16, 2018 por Carlos Rojas | Edita este Post.
ionic3.9.2ionic-native4.5.2ionic-app-scripts3.1.7cordova-cli7.1.0ionic-cli3.19.0

Cuando los proyectos en Ionic crecen un poco más de 50 componentes y tenemos varios desarrolladores en el proyecto, es buena idea tener Documentación de codigo para las generaciónes futuras.

En esta oportunidad voy a dar una continuación de nuestro post sobre Compodoc pero esta vez con Ionic.

Que es Compodoc ?

Compodoc es un generador de Documentación el cual va a leer los archivos de tu proyecto en Angular y va a generar una Documentación simple y elegante que va contener sus bloques de construcción junto con los comentarios que tengas en los mismos.

Si quieres ver más a fondo las caracteristicas de esta herramienta visita nuestro post sobre Compodoc.

Instalación.

En tu proyecto de Ionic.

npm install @compodoc/compodoc

Creamos una tarea en nuestro package.json para que sea mas facil.

"scripts": {
  ...
  "compodoc": "./node_modules/.bin/compodoc -d ./docs/ -p ./tsconfig.json"
}

y cada vez que queramos actualizar nuestra documentación simplemente usamos:

npm run compodoc

Uso.

Ejecuta la tarea.

npm run compodoc

Puedes correr un servidor local de tu preferencia o el que trae compodoc.

$ ./node_modules/.bin/compodoc -s -d ./docs/

Bueno espero que sea de ayuda y no te olvides comentar y compartir :)

¡Compártelo!