Voici ci-dessous un exemple de bloc de commentaires. Chaque fichier source d'un module peut inclure un ou plusieurs blocs de la sorte. Ces blocs peuvent apparaître à n'importe quel endroit du code source.
/** @block-tag Ce texte est associé avec la balise block-tag * * @keyword-tag Il peut y avoir n'importe quel nombre de balises keyword-tags dans un bloc de commentaires * * @keyword-tag Le texte peut apparaître sur la même ligne que la balise * Ou n'importe quelle ligne en dessous * * Les paragraphes sont séparés par une simple ligne */
Chaque bloc de commentaires doit commencer par /** (notez bien les deux astérisques) et finir par */. Il peut s'étendre sur plusieurs lignes. Les lignes blanches, avec un astérisque optionnel, sont ignorées.
Chaque bloc de commentaires peut inclure une ou plusieurs balises. Les balises dont des mots préfixés avec le caractère @ . La première balise d'un bloc de commentaires est appelée block tag et définit le rôle du bloc de commentaires courant. Les autres balises sont appelées keyword tags et sont utilisées pour délimiter les différentes parties du bloc. Les keyword tags pouvant apparaître dans un bloc dépendent du type de bloc (c'est à dire le block tag du bloc).
Le texte est associé avec la balise block ou keyword qui est placée avant. Le texte peut commencer sur la même ligne que la balise ou sur les lignes suivantes. Certaines balises peuvent acceptées plusieurs paragraphes de texte (par exemple, la balise @brief). Dans ce cas, les paragraphes sont séparés par des lignes blanches.
| Précédent | Sommaire | Suivant |
| Documentation des modules | Niveau supérieur | Bloc des informations sur le module |