Développement XNA pour la XBox et le PC
334
Générer de la documentation
Vous vous en doutez sûrement, apprendre à programmer sans support de documentation
est mission impossible. De la même manière, il est difficilement imaginable que vous
puissiez apprendre à vous servir d’une bibliothèque sans pouvoir vous appuyer sur une
source de documentation. Vous aurez donc certainement envie, vous aussi, d’utiliser les
fonctionnalités de génération de documentation de la suite Visual Studio afin de distribuer
vos projets accompagnés de cette source d’informations.
Nous l’avons vu au début du livre, il existe un format de commentaire particulier dédié à
la documentation, les trois slashs à la suite :
///
À la suite de ces slashs, vous écrivez une balise XML. Le tableau B-2 répertorie une
partie des balises existantes.
Une fois votre classe correctement documentée, signalez à l’environnement de développement qu’il doit générer un fichier .xml contenant la documentation du projet.
Tableau B-2 Les balises de documentation
Balise
Description
Utilisée pour donner la description complète d’une classe, fonction, propriété ou variable.
Utilisée pour la documentation d’un argument. Vous devez préciser le nom de l’argument.
Argument 1
Utilisée pour documenter la valeur de retour d’une fonction.
Utilisée pour documenter une propriété.
Utilisée pour signaler qu’un mot, utilisé par exemple dans une balise, est un paramètre
de la fonction.
Je parle de
Argument 1
Utilisée pour documenter du code sur une ligne (la différence avec du texte classique se situe au
niveau de l’affichage).
334
Générer de la documentation
Vous vous en doutez sûrement, apprendre à programmer sans support de documentation
est mission impossible. De la même manière, il est difficilement imaginable que vous
puissiez apprendre à vous servir d’une bibliothèque sans pouvoir vous appuyer sur une
source de documentation. Vous aurez donc certainement envie, vous aussi, d’utiliser les
fonctionnalités de génération de documentation de la suite Visual Studio afin de distribuer
vos projets accompagnés de cette source d’informations.
Nous l’avons vu au début du livre, il existe un format de commentaire particulier dédié à
la documentation, les trois slashs à la suite :
///
À la suite de ces slashs, vous écrivez une balise XML. Le tableau B-2 répertorie une
partie des balises existantes.
Une fois votre classe correctement documentée, signalez à l’environnement de développement qu’il doit générer un fichier .xml contenant la documentation du projet.
Tableau B-2 Les balises de documentation
Balise
Description
Utilisée pour donner la description complète d’une classe, fonction, propriété ou variable.
Utilisée pour la documentation d’un argument. Vous devez préciser le nom de l’argument.
Argument 1
Utilisée pour documenter la valeur de retour d’une fonction.
Utilisée pour documenter une propriété.
Utilisée pour signaler qu’un mot, utilisé par exemple dans une balise
de la fonction.
Argument 1
Utilisée pour documenter du code sur une ligne (la différence avec du texte classique se situe au
niveau de l’affichage).
Même chose que , mais supporte plusieurs lignes.
Utilisée pour ajouter des remarques ou commentaires par ticuliers.
Utilisée pour préciser le type d’exception que la fonction est susceptible de lever.
Utilisée pour donner un exemple d’utilisation d’un élément.
Utilisée pour créer un lien vers un autre élément.
Avez-vous vu ma méthode ?
Utilisée pour créer un lien en bas de page de la documentation.
=Labat FM.book Page 334 Vendredi, 19. juin 2009 4:01 16