NOTA BENE: Il Bloggatore ha rilevato dei problemi di collegamento con il blog indicato come fonte originale dell'articolo. Pertanto, al fine di consentire agli utenti di leggere questo articolo, se possibile, viene reso temporaneamente disponibile il post completo.
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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class foo
{
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
e qui i vari metodi
I commenti di questo genere si aggiungono con semplicità, creare l’intestazione della funzione, per esempio
12
3
4
public string get(string par1, int par2)
{
}
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.
Post correlati:
- C# come mandare email con allegati a piu destinatari
- href="http://codesnippet.altervista.org/Scaricare sorgente di una pagina in C#
- Articolo precedente: -DELETED-Patch pes 2009
- Articolo successivo: Guida:Installazione applicazioni & giochi su android
SEGNALA / INVIA QUESTO POST:
Hai trovato questo articolo interessante? Iscriviti GRATIS ai nostri feeds!
