Documentation de votre code avec le langage XML (Visual Basic)
En Visual Basic, vous pouvez documenter votre code avec le langage XML.
Commentaires de documentation XML
Visual Basic offre un moyen simple pour créer automatiquement de la documentation XML pour les projets. Vous pouvez générer automatiquement une structure XML pour vos types et vos membres, puis fournir des résumés, une documentation descriptive pour chaque paramètre, ainsi que d'autres notes. Si la configuration est appropriée, la documentation XML est émise automatiquement dans un fichier XML portant le même nom que votre projet et une extension .xml. Pour plus d'informations, consultez /doc.
Le fichier XML peut être soit consommé, soit manipulé en tant que XML. Il se trouve dans le même répertoire que le fichier de sortie .exe ou .DLL de votre projet.
La documentation XML commence par '''. Le traitement de ces commentaires s'accompagne de certaines restrictions :
Le XML utilisé dans la documentation doit être correct. Si le XML n'est pas correct, un avertissement est généré et le fichier de documentation contient un commentaire indiquant qu'une erreur est survenue.
Les développeurs sont libres de créer leur propre jeu de balises. Il existe un jeu de balises recommandé (consultez la section « Rubriques connexes »). Certaines des balises recommandées ont des significations spéciales :
La balise <param> est employée pour décrire les paramètres. Si elle est utilisée, le compilateur vérifiera que le paramètre existe et que tous les paramètres sont décrits dans la documentation. Si la vérification échoue, il émet un avertissement.
L'attribut cref peut être rattaché à n'importe quelle balise pour fournir une référence à un élément de code. Le compilateur vérifie l'existence de cet élément de code. Si la vérification échoue, il émet un avertissement. Le compilateur respecte également les instructions Imports lorsqu'il recherche un type décrit dans l'attribut cref.
La balise <summary> est employée par IntelliSense dans Visual Studio pour afficher d'autres informations sur un type ou un membre.
Rubriques connexes
Pour plus d'informations sur la création d'un fichier XML avec des commentaires de documentation, consultez les rubriques suivantes :