|
Ajout de la documentation à votre base NET Visual ( VB.NET ) projet est important pour que les gens en utilisant votre programme ont un endroit pour trouver plus d' informations sur les fonctionnalités qu'ils éprouvent des problèmes avec. . Visual Studio utilise '' ' pour signifier une ligne de documentation , où il crée automatiquement un modèle XML pour . Lorsque vous compilez votre projet , Visual Studio va créer un fichier XML à partir de tous vos commentaires sur la documentation . Choses que vous devez
Microsoft Visual Studio 2005, 2008 ou 2010
Afficher plus Instructions
1 Ouvrez votre projet VB.NET dans Microsoft Visual Studio 2005, 2008 ou 2010 .
2 trouver le code pour un type ou un membre que vous souhaitez documenter et placez votre curseur sur la ligne au-dessus du code. Un type inclut des choses comme une interface ou une classe. Les membres comprennent des choses comme un sous-programme , fonction , événement ou d'un bien .
3 Ajouter '' ' (3 caractères guillemets simples ) au début de la ligne . Ceci indique une ligne de documentation. L'éditeur de code va ajouter un squelette XML correspondant aux éléments sur la ligne en dessous.
4 Ajoutez votre documentation sous forme de texte entre les balises XML . Il est possible d'ajouter de nouveaux documents Commentez balises XML en éditant le fichier " VBXMLDOC.xml " avec un éditeur de texte . Le fichier se trouve dans " Application Data " de Visual Studio ou dossier " AppData " .
5 Ajoutez les lignes de code supplémentaires avec les commentaires de documentation XML qui utilisent le type ou membre . Un tag affiche des informations supplémentaires sur le type ou membre .
6 Cliquez sur votre projet dans l'Explorateur de solutions. Cliquez sur le menu «Projet» et cliquez sur «Propriétés». Cliquez sur l'onglet "Compiler" et ajouter " /doc " dans la case " Generate XML de documentation des dossiers " . Elle indique au compilateur de créer un fichier XML lorsque vous compilez le projet .
7 créer un fichier de documentation XML en compilant votre projet VB.NET . Le fichier apparaît dans le même dossier que votre fichier. Exe ou un fichier . Dll .
|
