ruby-on-rails - yard en inglés
¿Cómo documento las tareas de Rake con YARD? (1)
Me gustaría incluir información sobre las tareas de Rake en nuestra aplicación Rails. Usamos YARD para la documentación, y en este momento las páginas como lib/tasks/development.rake aparecen de forma predeterminada como texto sin formato.
Puedo hacer que se procesen como código fuente de Ruby usando # @markup ruby de la documentación de YARD .
Sin embargo, esto solo muestra los comentarios en línea, incluso si incluyen directivas YARD como # @!method foo . Esto significa que la documentación YARD sobre etiquetado de DSL no parece ser aplicable.
¿Me estoy perdiendo de algo?
¿Cómo puedo hacer que YARD reconozca el código frente a la documentación en archivos .rake ?
NB Me complacería con una solución que ignora el código real y simplemente genera una copia de la documentación, pero la fuente de la copia de la documentación debe ser el .rake archivo .rake . No quiero que la documentación se encuentre en un archivo .markdown separado (o lo que sea ) ya que hay demasiadas posibilidades de que se desincronice.
Más información - el comando de yard :
Estoy usando un archivo .yardopts que contiene lo siguiente:
--asset graphs ''app/**/*.rb'' ''lib/**/*.rb'' - README info/*
Para que YARD lea las tareas de Rake, puedo agregar ''lib/tasks/*.rake'' después del guión (es decir, agregar archivos de Rake a la lista de ''Archivos'' de YARD), pero como se indicó anteriormente, esto no los procesa correctamente.
Según la sugerencia de Benjamin a continuación, intenté agregar ''lib/tasks/*.rake'' antes del guión (es decir, agregar archivos Rake a la lista de archivos Ruby normales para ser procesados), pero esto no parece generar nada en absoluto.
Es posible que YARD esté generando algo pero no en la ubicación esperada / con el nombre de archivo esperado, supongo, no estoy lo suficientemente familiarizado con cómo funciona YARD para averiguar si hay salida huérfana en algún lugar. Ciertamente, no hay nada apropiado en la búsqueda que genere YARD, y un simple find doc | grep rake find doc | grep rake o find doc | grep basename_of_rake_file find doc | grep basename_of_rake_file no muestra nada.
De la documentación de YARD :
En la sección Guía de introducción con YARD en Uso de YARD para generar documentación , consulte Documentar archivos adicionales o Agregar metadatos a archivos adicionales . Podría ayudar.