Implementacion
Una vez que tenemos instalado todo ya podemos ponernos a documentar.
Para documentar un método o clase debemos escribir lo que consideremos necesario justo arriba del método o clase a documentar. De esta forma la gema se encarga de recolectar la documentación y mostrarla toda junta.
Yard sigue la misma sintaxis que rdoc para escribir la documentación. Pueden chequear como escribir la documentación en google así como también en este link https://github.com/lsegal/yard/wiki/Tags
Una vez que tenemos las clases/métodos que deseamos documentados podemos correr el comando para generar la documentacion
Esto nos generará la documentación en la carpeta de nuestro proyecto /doc
La gema genera simple HTML, por lo tanto para abrir y leer la documentacion solo debemos clickear en /doc/index.html y ver la página con toda nuestra documentación armada.
Last updated