In questo articolo impareremo i commenti C #, i diversi stili di commenti e perché e come usarli in un programma.
I commenti vengono utilizzati in un programma per aiutarci a comprendere un pezzo di codice. Sono parole leggibili dall'uomo destinate a rendere leggibile il codice. I commenti vengono completamente ignorati dal compilatore.
In C # sono disponibili 3 tipi di commenti:
- Commenti su una riga (
//) - Commenti su più righe (
/* */) - Commenti XML (
///)
Commenti su una riga
I commenti su una riga iniziano con una doppia barra //. Il compilatore ignora tutto ciò che segue //fino alla fine della riga. Per esempio,
int a = 5 + 7; // Aggiunta di 5 e 7
Ecco Adding 5 and 7il commento.
Esempio 1: utilizzo di un commento a riga singola
// Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )
Il programma sopra contiene 3 commenti a riga singola:
// Hello World Program // L'esecuzione inizia dal metodo Main
e
// Stampa Hello World
I commenti a riga singola possono essere scritti in una riga separata o insieme ai codici nella stessa riga. Tuttavia, si consiglia di utilizzare i commenti in una riga separata.
Commenti su più righe
I commenti su più righe iniziano con /*e terminano con */. I commenti su più righe possono estendersi su più righe.
Esempio 2: utilizzo di commenti su più righe
/* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )
Il programma sopra contiene 2 commenti su più righe:
/ * Questo è un programma Hello World in C #. Questo programma stampa Hello World. * /
e
/ * Stampe Hello World * /
Qui, potremmo aver notato che non è obbligatorio che un commento su più righe si estenda su più righe. /*… */può essere utilizzato al posto di commenti a riga singola.
Commenti sulla documentazione XML
Il commento sulla documentazione XML è una funzionalità speciale in C #. Inizia con una tripla barra ///e viene utilizzato per descrivere categoricamente un pezzo di codice … Questo viene fatto utilizzando tag XML all'interno di un commento. Questi commenti vengono quindi utilizzati per creare un file di documentazione XML separato.
Se non si ha familiarità con XML, vedere Che cos'è XML?
Esempio 3: utilizzo del commento della documentazione XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Il commento XML utilizzato nel programma precedente è
/// /// Questo è un programma Hello World. ///
La documentazione XML (file .xml) generata conterrà:
Ciao mondo
Se sei interessato a saperne di più, visita Commenti sulla documentazione XML.
Usa i commenti nel modo giusto
I commenti sono usati per spiegare parti di codice ma non dovrebbero essere abusati.
Per esempio:
// Stampa Hello World Console.WriteLine ("Hello World");
L'uso del commento nell'esempio precedente non è necessario. È ovvio che la riga stamperà Hello World. I commenti dovrebbero essere evitati in questi casi.
- Invece i commenti dovrebbero essere usati nel programma per spiegare algoritmi e tecniche complessi.
- I commenti dovrebbero essere brevi e pertinenti invece di una lunga descrizione.
- Come regola generale, è meglio spiegare perché invece di come , usando i commenti.
