Microsoft et d'autres développeurs de logiciels recommande commenter votre code. Documentation de code vous permet de comprendre le logiciel que vous créez. Il aide aussi les programmeurs qui peuvent maintenir votre application dans le futur . Visual Studio programme de Microsoft simplifie le processus de documentation du logiciel. Il suffit d'ajouter du texte XML à votre code , et le logiciel va incorporer vos commentaires dans l'application. Après la compilation du projet , tout le monde peut voir vos commentaires sur une page Web. Instructions
Créer un projet
1
Ouvrez Visual Studio. Sélectionnez "Fichier" et "Nouveau projet" pour ouvrir le "Nouveau projet" fenêtre.
2
Cliquez sur " Visual C #" pour le sélectionner et double -cliquez sur " Application Web ASP.NET. " < Br >
3
type " My_Website " dans la boîte de texte "Nom " et cliquez sur "OK". Visual Studio va créer un nouveau projet nommé " My_Website " et afficher ses fichiers de projet dans le panneau Explorateur de solutions. Vous verrez un fichier nommé " Default.aspx " dans l' Explorateur de solutions. Ceci est la page principale du site.
4
Cliquez sur la flèche à côté de " Default.aspx " et double -cliquez sur " Default.aspx.cs . " Ce fichier contient le code C # de la page.
5
Double -cliquez sur " Default.aspx.cs . " Visual Studio affichera son code dans la fenêtre de code . Vous verrez une méthode nommée " Page_Load " qui ressemble à ceci :
protected void Page_Load (object sender, EventArgs e) {
}
cette méthode fonctionne quand un navigateur charge la page
6
Ajoutez la ligne de code suivante entre les deux personnages du support :
int carPrice = computePrice ();
< p. > Cela appelle une autre méthode nommée computePrice . Après l'ajout de code, la méthode ressemblera à ceci :
protected void Page_Load (object sender, EventArgs e) {
int carPrice = computePrice ();
}
7
Ajoutez la méthode suivante après le dernier caractère de support de la méthode précédente :
private int computePrice () { int
basePrice = 20000 ;
int impôt = 1,800 ;
int totalPrice = basePrice + taxes ;
totalPrice de retour;
}
Cette méthode calcule un total prix avec un prix de base et la taxe de vente . La méthode n'a pas de commentaires pour le moment .
8
Placez votre curseur de la souris au-dessus " int computerPrice privé () { " et tapez " ///" ( sans les guillemets) . Appuyez sur "Entrée". Visual Studio vous permet de convertir les trois barres obliques dans le bloc de texte suivant:
///
///Photos
///
Photos
/// Photos
texte que vous entrez dans ce bloc apparaîtra dans les commentaires XML de la page Web . Ce bloc de code a un endroit pour mettre un résumé de la méthode et le type de valeur que la méthode renvoie
9
Modifier le bloc de code afin qu'il ressemble à ceci: .
///Photos ///Cette méthode calcule un prix total en utilisant un prix de base et la taxe de vente .
///
Photos
/// la méthode retourne le prix total de la méthode d'appel . Photos
La section «Résumé » décrit maintenant la section " retourne" méthode et décrit le type de variable que les rendements de la méthode.
View Commentaire page Web
10
situer le projet « My_Website " dans l'explorateur de solution »et cliquez-droit dessus . sélectionnez" Propriétés " à ouvrir la fenêtre "Propriétés" du projet.
11
Cliquez sur l'onglet "Build" et de mettre une coche à côté de " fichier de documentation XML. "
12
cliquez sur "Parcourir . " Explorateur Windows s'ouvre et affiche du projet « Le chemin de sortie. " c'est l'endroit où Visual Studio va stocker le projet compilé .
13
Situer la barre d'adresse en haut de l'Explorateur Windows. Vous verra un chemin de dossier Il sera généralement ressembler à ceci: .
myUserAccount \\ Documents \\ Visual studio 2010 \\ Project \\ My_Website \\ monsite \\ bin
La trajectoire réelle peut différer sur votre ordinateur < . br> 14
un clic droit sur une zone vide de la barre d' adresse et sélectionnez " copier l'adresse. " Windows va copier le chemin de votre presse-papiers. Cliquez sur " Annuler " pour fermer l'Explorateur Windows.
15
Déplacer vers l' Explorateur de solutions et cliquez droit sur " My_Website . " Select "Build ". Visual Studio compile le projet et créer un fichier XML contenant vos commentaires .
16
Cliquez sur Windows bouton "Démarrer" du menu et cliquez-droit sur la case «Recherche » au bas du menu Démarrer. Sélectionnez "Coller". Windows va coller le chemin que vous avez copié dans la boîte "Rechercher" .
17 < p> Appuyez sur " Entrée". Explorateur Windows s'ouvre et affiche le contenu du dossier qui contient le projet compilé .
18
Situer " My_Website.XML " et cliquez-droit sur ce fichier. Sélectionnez "Open avec "puis sélectionnez " Internet Explorer ". Internet Explorer s'ouvre et affiche une page Web qui affiche vos commentaires .
