Documentation

D intègre directement beaucoup de techniques de programmation moderne. En plus de la programmation par contrats et des tests unitaires, D permet de générer de la documentation à partir du code source.

En lisant des commentaires dans un format standard pour documenter les types et les fonctions, la commande dmd -D génère une documentation au format HTML à partir des fichiers sources qui lui sont fournis. En fait, l'intégralité de la documentation de Phobos a été générée à l'aide de DDoc.

Les styles de commentaires suivants sont interprétés par DDoc pour générer de la documentation:

• /// Trois barres obliques avant un type ou une fonction
• /++ Commentaire multi-ligne avec deux + +/
• /** Commentaire multi-ligne avec deux * */

Jetez un coup d'œil au code source d'exemple pour découvrir quelques uns des champs que peuvent contenir ces commentaires.

Pour aller plus loin

• Fonctionnement de DDoc
• Documentation de la librairie standard

rdmd playground.d