Blog de Luis Arévalo


XQDoc: Una herramienta para la Auto-Documentación de código XQuery


Feb 08

Posted: under eXist, XML, XQuery.
Tags: , ,

XQDoc es una herramienta para la generación automática de documentación en formato HTML a partir de código fuente XQuery, es decir, es la herramienta Javadoc para código XQuery (Javadoc una utilidad de Sun Microsystems para la generación de documentación automática de APIs en formato HTML). Este post surgió a partir de mi anterior entrada sobre «Guía de estilos en XQuery«.

Al igual que en Javadoc, es necesario introducir comentarios especiales en los módulos/ficheros XQuery para que posteriormente la herramienta pueda generar la documentación HTML. Principalmente deben documentarse dos elementos: more_link_text

Comments (0)

Guía de Estilo para XQuery


Feb 01

Posted: under eXist, XML, XQuery.
Tags: , ,

Todo lenguaje de programación tiene su propia «guía de codificación», consensuada generalmente por un grupo de «expertos» en la materia, que facilitan la codificación y compresión de código para dicho lenguaje. Y para no ser menos, también existe una guía para el lenguaje XQuery (Guía de Estilo).

En ella se establece entre otras cosas:

  • Modulos XQuery. Como realizar la correcta definición de modulos  XQuery y posteriormente realizar su importación.
  • Indentación
  • Comentarios donde existe un formato similar a Javadoc para posteriormente generar la documentación HTML automáticamente (Herramienta xqdoc)
  • El correcto orden de las expresiones
  • Colocación de los espacios en blancos.
  • Buenas prácticas de codificación.

A partir de ahora, otro manual para tener siempre encima de la mesa de trabajo.

Comments (0)