Comentarios en Swift

En este artículo, aprenderá sobre los comentarios de Swift, por qué y cómo usarlos.

Los comentarios son explicaciones o comentarios legibles por el programador en el código fuente del programa. Durante la compilación del código, el compilador lo ignora.

Los comentarios están diseñados para que las personas que lean el código entiendan mejor la intención y la función del programa. Al trabajar en equipo, puede ser útil aclarar el propósito del código para otros miembros del equipo, o puede recordar su propio propósito cuando trabaja solo.

Comentarios de Swift y sus tipos

Swift tiene dos tipos de comentarios:

1.comentarios de una sola línea

En Swift, cualquier línea que comience con dos diagonales invertidas // Las líneas que comienzan con dos diagonales invertidas son comentarios de una sola línea, todos los que comienzan con dos diagonales invertidas // Las líneas que comienzan con dos diagonales invertidas son ignoradas por el compilador.

Puede encontrar un ejemplo simple en la parte superior de playground:

//: Playground　-　sustantivo: un lugar donde las personas pueden jugar

que comienza con dos diagonales invertidas // que comienza y proporciona una explicación significativa al archivo, por ejemplo: "Playground" - sustantivo: un lugar donde las personas pueden jugar.

Ejemplo1: comentarios de una sola línea

//Programa de muestra
//almacena　3.14　en variable pi
let pi =　3.14159　
print(pi)

El ejemplo anterior contiene dos comentarios de una sola línea:

//　Programa de muestra
//　almacena　3.14　en variable pi

2.comentarios de múltiples líneas

Si sus comentarios contienen múltiples líneas, puede encerrarlos en/*...*/.

Los comentarios de múltiples líneas comienzan con una diagonal invertida (/*) que termina con un asterisco, seguido de una diagonal invertida (*/) Será ignorado por el compilador de Swift./* y */Todo el contenido entre

/*　Este es un comentario de múltiples líneas.
Agregue en la parte posterior de los comentarios de múltiples líneas*, seguido de/para finalizarlo
*/

Ejemplo2: comentarios de múltiples líneas

/*　El valor de pi codificado en forma rígida puede no ser tan preciso.
Por lo tanto, puede usar tipos de datos integrados para calcular valores más precisos
*/
let pi = Double.pi
print(pi)

El ejemplo anterior contiene comentarios de múltiples líneas.

/*　El valor de pi codificado en forma rígida puede no ser tan preciso.
Por lo tanto, puede usar tipos de datos integrados para calcular valores más precisos
*/

Cosas que hay que recordar

Aunque los comentarios son muy útiles para entender mejor la intención del código que se escribe. Pero hay que tener en cuenta que:

1. No incluya comentarios en comentarios de múltiples líneas.//En, aunque es válido, el compilador ignora estas líneas. En su lugar, debería colocarlo en un comentario de múltiples líneas./* ... */中
   Por ejemplo:

   //Este es un comentario.
   //Úselo cuando sea necesario y de manera precisa

   El método de escribir comentarios mencionado anteriormente es correcto, pero no se recomienda hacerlo, porque si el comentario es mayor de una línea,则需要多行注释。Una mejor manera de escribir es usar comentarios en múltiples líneas como:

   /*　Este es un comentario.
   Úselo cuando sea necesario y de manera precisa
   */

2. Los comentarios en una sola línea pueden escribirse en una línea separada o junto con el código en la misma línea. Sin embargo, se recomienda usar una línea separada para los comentarios.
   Por ejemplo:

   let pi =　3.14159　//almacena　3.14　en variable pi

   Este método de escritura de comentarios es efectivo. Sin embargo, es mejor escribir comentarios en una línea separada:
   

   //almacena　3.14　en variable pi
   let pi =　3.14159

3. Incluso si es el único desarrollador en su equipo y es el único que escribe código, es difícil encontrar el uso del código sin comentarios. Por lo tanto, úselo de manera precisa y proporcione una descripción significativa.

4. Haga que los comentarios sean muy simples y significativos.

5. No escriba comentarios innecesarios en el código.

6. En la mayoría de los casos, utilice comentarios para explicar 'por qué' en lugar de 'cómo'.