2010-09-03 24 views
21

La documentación creada al ejecutar grails doc no es del todo satisfactoria para mí. Por ejemplo, las acciones en los controladores aparecen como propiedades en la documentación, aunque me gustaría tener una sección adicional para separar las acciones de las propiedades reales (cadenas, etc.).Grails: Alternativas al Doc Grails?

¿Hay alguna herramienta que opere en comentarios tipo JavaDoc y genere un mejor resultado para los proyectos de Grails? Debería tener conocimiento de Grails (es decir, entiende que los cierres en los controladores son en realidad acciones) o permitir el etiquetado explícito (por ejemplo, un comentario @section Actions hace que el párrafo aparezca en una sección llamada "Acciones")

Respuesta

1

Consulte el complemento "Grails Runtime Docs" (http://grails.org/plugin/grails-runtime-docs). Generará una excelente documentación desde el tiempo de ejecución, incluidos los métodos dinámicos, y agregará el "Resumen del método dinámico" & "Detalle del método dinámico" en los documentos html generados que proporcionan su información de origen. Es más consciente de Grails y categoriza las clases en Controladores, Comandos, Dominios, Servicios y Bibliotecas de Etiquetas. Nota: Soy un desarrollador de Grails y contribuí este plugin de código abierto con Grails. Esperamos que te sea útil.

+0

Debe revelar que el enlace es a un documento que creó – Skuld

+0

@Skuld: Gracias por la sugerencia. Acabo de enterarme de la divulgación y edité mi respuesta en consecuencia. La página está creada por Grails para que el autor contribuya con un complemento. Gracias. –

+0

No te preocupes, solo un aviso en serio, si publicas demasiado y no divulgas, podrías ser marcado como spam. :) – Skuld

1

Parece que está ejecutando una versión anterior de Grails.

La última versión de Grails contiene muchas mejoras en el documento de Grails. Además, Grails ahora recomienda que las acciones del controlador se codifiquen como métodos en lugar de como cierres, lo que puede resolver su problema.

Si le preocupa la actualización, he estado utilizando Grails desde 2008 y siempre actualizo cuando salgan nuevas versiones.

Nunca se ha necesitado más de un día para actualizar Grails, actualizar el código para abordar cualquier "cambio de rotura" documentado, ejecutar las pruebas y revertir si encuentro algún problema.

Como actualizar es tan fácil, siempre trato de mantenerme actualizado con la última versión estable.

Por cierto, los complementos pueden ser problemáticos. Debería, por supuesto, tener pruebas para cualquier complemento que use. De hecho, los mejores complementos ya incluyen pruebas, que puedes ejecutar.

+0

Muchas gracias. Hace algunas semanas, ya nos hemos actualizado a la última versión de Grails, pero como pueden ver, esta pregunta es de 2010. De todos modos, probaré el nuevo Grailsdoc. –