.NET Commenti XML nel codice
Link sponsorizzati
Avete mai sentito parlare dei commenti XML? Quelli che permettono a Visual Studio di creare la documentazione ‘al momento’. Per esempio prendiamo la classe WebClient, questo è un esempio di quello che intendo
quel suggerimento c’è grazie ai commenti XML, che possiamo aggiungere anche noi al nostro codice per esempio. Prendiamo in considerazione questa classe
{
private string bar;
/// <summary>
/// costruttore di defautl
/// </summary>
public foo()
{
this.bar = "";
}
/// <summary>
/// secondo costruttore
/// </summary>
/// <param name="bar">Inserisci il paramentro bar che non serve a nulla</param>
public foo(string b)
{
this.bar = b;
}
/// <summary>
/// non fa assolutamente niente questa funzione
/// </summary>
/// <returns>"Yes is bar!!" se il parametro bar è uguale a "bar", ""Wrong!"" altrimeni</returns>
public string doSomething()
{
if (this.bar == "bar")
return "Yes is bar!!";
return "Wrong!";
}
/// <summary>
/// Fa la somma di tre numeri
/// </summary>
/// <param name="a">primo numero</param>
/// <param name="b">secondo numero</param>
/// <param name="c">terzo numero</param>
/// <returns>Torna un intero che rappresenta la somma</returns>
public int sum(int a, int b, int c)
{
return a + b + c;
}
}
Ecco come vengono mostrati i suggerimenti nel codice
Link sponsorizzati
e qui i vari metodi
I commenti di questo genere si aggiungono con semplicità, creare l’intestazione della funzione, per esempio
{
}
ora, andate sopra la funzione e digitate, per C#, ///, la struttura viene creata automaticamente. Per il Visual Basic .NET vale la stessa cosa, ma dovete mettere ovviamente ”’ per creare la struttura (‘ è il commento per VB). L’IDE (Visual Studio) interpreta direttamente quel codice e fornisce i suggerimenti quando si va ad utilizzare la classe.
Questo tipo di commenti sono molto utili, perchè permettono di avere una ‘documentazione’ direttamente sul codice, usateli, sono molto comodi.
Link sponsorizzati
