In questo articolo, imparerai a conoscere i commenti Swift, perché e come usarli.
Un commento è una spiegazione o annotazione leggibile dal programmatore nel codice sorgente di un programma. Viene ignorato dal compilatore quando il codice viene compilato.
I commenti sono destinati alla persona che legge il codice per comprendere meglio l'intento e la funzionalità del programma. Può essere utile mentre si lavora in un team chiarire lo scopo del codice per altri membri del team o mentre si lavora esclusivamente può fungere da promemoria per il possesso.
Commento rapido e suoi tipi
In swift ci sono due tipi di commenti:
1. Commento su una riga
In Swift, qualsiasi riga che inizia con due barre //è un commento a riga singola, tutto ciò che inizia con due barre //viene ignorato dal compilatore.
Puoi trovare un semplice esempio nella parte superiore del playground:
//: Playground - sostantivo: un luogo dove le persone possono giocare
Inizia con due barre //e fornisce una spiegazione significativa del file come ": Parco giochi - nome: un luogo dove le persone possono giocare".
Esempio 1: commento a riga singola
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
L'esempio sopra contiene due commenti a riga singola:
// Programma di esempio // memorizza 3.14 nella variabile pi
2. Commento multilinea
Se il tuo commento include più righe, puoi racchiuderlo all'interno /*… */.
I commenti su più righe iniziano con una barra in avanti seguita da un asterisco ( /*) e terminano con un asterisco seguito da una barra in avanti ( */). Tutto ciò che sta in mezzo /*e */viene ignorato dal compilatore rapido.
/ * Questo è un commento su più righe. Dopo aver scritto un commento su più righe, aggiungi * seguito da / per terminarlo * /
Esempio 2: commento su più righe
/* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)
L'esempio precedente contiene un commento su più righe.
/ * Il valore pi hardcoded potrebbe essere meno accurato. Quindi puoi calcolare utilizzando i tipi di dati costruiti per un valore più accurato * /
Cose da ricordare
Sebbene i commenti siano significativi per comprendere meglio l'intento del codice scritto. Ecco le cose che devi considerare mentre lo scrivi:
- Non racchiudere commenti con // su più righe sebbene sia valido e il compilatore ignori quelle righe. Racchiudilo invece all'interno di un commento su più righe
/*… */
Esempio:// Questo è un commento. // Usalo quando necessario e con precisione
Il modo precedente per scrivere un commento è corretto ma non consigliato perché è necessario scrivere commenti su più righe se il commento è maggiore di una riga. Il modo migliore per scrivere è usare commenti su più righe come:/ * Questo è un commento. Usalo quando necessario e con precisione * /
- Il commento a riga singola può essere scritto in una riga separata o insieme al codice nella stessa riga. Tuttavia, si consiglia di utilizzare i commenti in una riga separata.
Esempio:let pi = 3.14159 // memorizza 3.14 nella variabile pi
Questo modo di scrivere commenti è valido. Ma è meglio scrivere un commento in una riga separata come:// memorizza 3.14 nella variabile pi let pi = 3.14159
- Anche se sei un singolo sviluppatore in un team e sei l'unico a scrivere il codice, se non è commentato, avrai difficoltà a cercare di capire il suo scopo nel programma. Quindi, usalo con precisione e fornisci una descrizione significativa.
- Rendi il commento molto semplice e significativo.
- Non scrivere commenti non necessari sul tuo codice.
- Nella maggior parte dei casi, utilizza i commenti per spiegare "perché" anziché "come".
