Partager via

Documenter votre code avec XML (Visual Basic)

Dans Visual Basic, vous pouvez documenter votre code à l’aide de XML.

Commentaires sur la documentation XML

Visual Basic offre un moyen simple de créer automatiquement une documentation XML pour les projets. Vous pouvez générer automatiquement un squelette XML pour vos types et membres, puis fournir des résumés, une documentation descriptive pour chaque paramètre et d’autres remarques. Avec la configuration appropriée, la documentation XML est automatiquement émise dans un fichier XML portant le même nom de fichier racine que votre projet. Pour plus d’informations sur la configuration de la génération du fichier de documentation XML, consultez l’option du compilateur -doc et la propriété GenerateDocumentationFile MSBuild.

Le fichier XML peut être utilisé ou manipulé comme un fichier XML. Ce fichier 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 comporte certaines restrictions :

  • La documentation doit être xml bien formée. Si le code XML n’est pas bien formé, un avertissement est généré et le fichier de documentation contient un commentaire indiquant qu’une erreur a été rencontrée.

  • Les développeurs sont libres de créer leur propre ensemble de balises. Il existe un ensemble recommandé de balises (voir Balises de commentaire XML). Certaines des balises recommandées ont des significations spéciales :

    • La balise <param> est utilisée pour décrire les paramètres. S’il est utilisé, le compilateur vérifie que le paramètre existe et que tous les paramètres sont décrits dans la documentation. Si la vérification échoue, le compilateur émet un avertissement.

    • L’attribut cref peut être joint à n’importe quelle balise pour fournir une référence à un élément de code. Le compilateur vérifie que cet élément de code existe. Si la vérification échoue, le compilateur émet un avertissement. Le compilateur respecte également les déclarations Imports lors de la recherche d’un type décrit par l’attribut cref .

    • La balise <summary> est utilisée par IntelliSense dans Visual Studio pour afficher des informations supplémentaires sur un type ou un membre.

Pour plus d’informations sur la création d’un fichier XML avec des commentaires de documentation, consultez les rubriques suivantes :

Voir aussi