Swift注释

In questo articolo, imparerai i commenti Swift, perché e come usarli.

I commenti sono spiegazioni o annotazioni leggibili dal programma che il programmatore può inserire nel codice sorgente. Durante la compilazione del codice, il compilatore ignora loro.

I commenti sono utili per far capire meglio a chi legge il codice l'intenzione e la funzione del programma.工作时，为其他团队成员澄清代码的目的可能会很有帮助，或者在单独工作时，它可以起到提醒自己的作用。

Commenti Swift e loro tipi

Swift ha due tipi di commenti:

1. Commenti a riga singola

In Swift, ogni riga che inizia con due slash // è un commento a riga singola, tutte le righe che iniziano con due slash // vengono ignorate dal compilatore.

Puoi trovare un esempio semplice nella parte superiore di playground:

//: Playground - nome: un luogo dove le persone possono giocare

Inizia con due slash // e fornisce una spiegazione significativa al file, ad esempio: "Playground - nome: un luogo dove le persone possono giocare".

Esempio 1: commenti a riga singola

//Esempio di programma
//stores 3.14 in variable pi
let pi = 3.14159　
print(pi)

L'esempio sopra contiene due commenti a riga singola:

//Esempio di programma
//Memorizza 3.14 nella variabile pi

2. Commenti multipli

Se il tuo commento contiene più righe, puoi metterlo tra /*...*/.

I commenti multipli iniziano con una barra obliqua (/) seguita da un asterisco(/*) e terminano con un asterisco seguiti da una barra obliqua (*/),. Il compilatore Swift ignora tutto il contenuto tra /* e */.

/* Questo è un commento multilinea.
Aggiungi * dopo aver scritto un commento multilinea, seguiti da / per terminare
*/

Esempio 2: commenti multipli

/* Il valore di pi hardcodato potrebbe non essere così preciso.
Quindi, puoi utilizzare i tipi di dati integrati per calcolare valori più precisi
*/
let pi = Double.pi
print(pi)

L'esempio sopra contiene commenti multipli.

/* Il valore di pi hardcodato potrebbe non essere così preciso.
Quindi, puoi utilizzare i tipi di dati integrati per calcolare valori più precisi
*/

Cosa ricordare

Sebbene i commenti siano molto utili per comprendere meglio l'intenzione del codice scritto, è necessario notare che:

1. Non includere i commenti nei // in un multilinea, anche se è valido e il compilatore ignora queste righe. Invece, metterli nei commenti multipli /* ... */
   例如：

   //Questo è un commento.
   //Utilizzare quando necessario e con precisione

   Il metodo di scrittura dei commenti descritto qui è corretto, ma non è consigliato farlo, perché se i commenti superano una riga, è necessario scrivere un commento su più righe. Un modo migliore di scrivere è utilizzare i commenti multipli come:

   /* This is a comment.
   Use it when necessary and precisely
   */

2. 单行注释可以写在单独的一行中，也可以与代码一起写在同一行中。但是，建议在单独的行中使用注释。
   例如：

   let pi = 3.14159 //stores 3.14 in variable pi

   这种编写注释的方法是有效的。但是最好把注释写在单独一行:
   

   //stores 3.14 in variable pi
   let pi = 3.14159

3. 即使您是一个团队中的单个开发人员，并且您是唯一一个编写代码的人，如果代码没有注释，您也很难在程序中找到它的用途。所以，准确地使用它，并提供一个有意义的描述。

4. 使注释非常简单和有意义。

5. 不要在代码上写不必要的注释。

6. 在大多数情况下，请使用注释来解释“为什么”而不是“如何”。