Documentación

D intenta integrar partes importantes de la ingeniería de software moderna dentro del propio lenguaje. Además de la programación por contrato y los tests unitarios, D permite generar documentación fuera del código fuente de forma nativa.

Usando un esquema estándar para documentar tipos de datos y funciones, el comando dmd -D genera convenientemente documentación en HTML basada en los archivos de código fuente pasados en la línea de comandos. De hecho, toda la documentación de la librería estándar, Phobos, está generada mediante este método, llamado DDoc.

Los siguientes tipos de comentarios son considerados por el generador de documentación, DDoc, como documentación para sacar fuera del código fuente:

• /// Tres barras inclinadas antes de cualquier tipo o función
• /++ Comentarios multilínea comenzando por dos signos más (+) +/
• /** Comentarios multilínea comenzando por dos asteriscos (*) */

Para ver cómo funciona la documentación estándar se puede echar un vistazo al código fuente de ejemplo.

En profundidad

• DDoc design
• Phobos standard library documentation

rdmd playground.d