Note
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier les répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de changer de répertoire.
Le compilateur Visual Basic peut traiter les commentaires de documentation dans votre code dans un fichier XML. Vous pouvez utiliser des outils supplémentaires pour traiter le fichier XML dans la documentation.
Les commentaires XML sont autorisés sur les constructions de code telles que les types et les membres de type. Pour les types partiels, une seule partie du type peut avoir des commentaires XML, bien qu’il n’y ait aucune restriction sur le commentaire de ses membres.
Remarque
Les commentaires de documentation ne peuvent pas être appliqués aux espaces de noms. C’est pourquoi un espace de noms peut s’étendre sur plusieurs assemblys, et tous les assemblys ne doivent pas être chargés en même temps.
Le compilateur traite n’importe quelle balise valide XML. Les balises suivantes fournissent les fonctionnalités couramment utilisées dans la documentation utilisateur.
- <c>
- <code>
- <exemple>
- <exception>1
- <include>1
- <liste>
- <Para>
- <param>1
- <paramref>
- <autorisation>1
- <Remarques>
- <Retourne>
- <voir>1
- <seealso>1
- <résumé>
- <typeparam>1
- <typeparamref>
- <valeur>
(1 Le compilateur vérifie la syntaxe.)
Remarque
Si vous souhaitez que les crochets angle apparaissent dans le texte d’un commentaire de documentation, utilisez < et >. Par exemple, la chaîne "<text in angle brackets>" s’affiche sous la forme <text in angle brackets>.
Voir aussi
Collaborez avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner des problèmes et des demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.
