Balises XML recommandées pour les commentaires de documentation (Visual Basic)
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.
Notes
Les commentaires de documentation ne peuvent pas être appliqués aux espaces de noms. La raison est qu’un espace de noms peut s’étendre sur plusieurs assemblys, et pas tous les assemblys doivent être chargés en même temps.
Le compilateur traite toute balise valide XML. Les balises suivantes fournissent des fonctionnalités couramment utilisées dans la documentation utilisateur.
- <C>
- <Code>
- <Exemple>
- <exception1>
- <include1>
- <Liste>
- <Para>
- <param1>
- <paramref>
- <permission1>
- <Remarques>
- <Retourne>
- <see1>
- <seealso1>
- <Résumé>
- <typeparam1>
- <Valeur>
(1 Le compilateur vérifie la syntaxe.)
Notes
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 en tant que <text in angle brackets>.