Ddoc es un generador de documentación integrado en el compilador y sintaxis asociada, para el lenguaje de programación D , diseñado por Walter Bright . Su énfasis está en poder escribir documentación en comentarios de código en un estilo natural, minimizando la necesidad de marcado incrustado y mejorando así la legibilidad de los comentarios de código. Es similar en concepto a Doxygen y Javadoc .
Los comentarios de código están asociados con símbolos en el código, y Ddoc usa la información semántica y sintáctica disponible del compilador D para completar información de rutina, como parámetros y tipos de retorno automáticamente.
Ddoc procesa los comentarios de código y la información de la tabla de símbolos en un formato estructurado interno. Cada una de estas estructuras corresponde a una plantilla expresada como una macro . Las macros de plantilla convierten el formato estructurado en otro conjunto de macros que expresan el marcado. El último conjunto de macros de marcado se expande para producir, de forma predeterminada, HTML .
Tanto las macros de plantilla como las macros de marcado pueden ser anuladas por el usuario y pueden aplicarse a través de archivos externos análogos a las hojas de estilo HTML. Las macros de plantilla se pueden cambiar para personalizar el formato de alto nivel, y las macros de marcado se pueden modificar para producir otras formas de salida como XML y XHTML .
Opciones del compilador
Hay varias opciones del compilador disponibles para hacer que el compilador dmd D genere un archivo de documentación HTML:
- -D generar documentación: la salida tendrá el mismo nombre que el archivo fuente D, con la extensión ".d" reemplazada por ".html".
- -Dd
escribe el archivo de documentación en el directorio, el nombre del archivo de salida es el mismo que el de la opción -D. - -Df
escribe el archivo de documentación en el nombre de archivo (no agrega automáticamente la extensión .html)
enlaces externos
- Especificación ddoc
- CandyDoc - conjunto de macros avanzadas para Ddoc