En este artículo, aprenderá sobre los comentarios de Swift, por qué y cómo usarlos.
Un comentario es una explicación o anotación legible por el programador en el código fuente de un programa. El compilador lo ignora cuando se compila el código.
Los comentarios están destinados a la persona que lee el código para comprender mejor la intención y la funcionalidad del programa. Puede ser útil mientras se trabaja en equipo para aclarar el propósito del código para otros miembros del equipo o mientras se trabaja únicamente, puede actuar como un recordatorio de la propiedad.
Comentario rápido y sus tipos
En swift hay dos tipos de comentarios:
1. Comentario de una sola línea
En Swift, cualquier línea que comience con dos barras //es un comentario de una sola línea. Todo lo que comience con dos barras //es ignorado por el compilador.
Puede encontrar un ejemplo sencillo en la parte superior del patio de juegos:
//: Patio de juegos - sustantivo: un lugar donde la gente puede jugar
Comienza con dos barras //y proporciona una explicación significativa del archivo como ": Patio de juegos - sustantivo: un lugar donde la gente puede jugar".
Ejemplo 1: comentario de una sola línea
//Sample program //stores 3.14 in 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 la variable pi
2. Comentario de varias líneas
Si su comentario incluye varias líneas, puede adjuntarlo dentro /*… */.
Los comentarios de varias líneas comienzan con una barra inclinada seguida de un asterisco ( /*) y terminan con un asterisco seguido de una barra inclinada ( */). Todo lo que hay en el medio /*y */es ignorado por el compilador rápido.
/ * Este es un comentario de varias líneas. Después de escribir un comentario de varias líneas, agregue * seguido de / para finalizarlo * /
Ejemplo 2: comentario de varias líneas
/* 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)
El ejemplo anterior contiene un comentario de varias líneas.
/ * El valor pi codificado puede ser menos preciso. Por lo tanto, puede calcular utilizando tipos de datos integrados para obtener un valor más preciso * /
Cosas para recordar
Aunque los comentarios son significativos para comprender mejor la intención del código escrito. Aquí hay cosas que debe considerar al escribirlo:
- No incluya comentarios con // en multilínea aunque es válido y el compilador ignora esas líneas. En su lugar, encárguelo dentro de un comentario de varias líneas
/*… */
Ejemplo:// Este es un comentario. // Úselo cuando sea necesario y con precisión
La forma anterior de escribir un comentario es correcta pero no se recomienda porque necesita escribir comentarios de varias líneas si el comentario es mayor que una línea. La mejor manera de escribir es usar un comentario de varias líneas como:/ * Este es un comentario. Úselo cuando sea necesario y con precisión * /
- Los comentarios de una sola línea se pueden escribir en una línea separada o junto con el código en la misma línea. Sin embargo, se recomienda utilizar los comentarios en una línea separada.
Ejemplo:let pi = 3.14159 // almacena 3.14 en la variable pi
Esta forma de escribir comentarios es válida. Pero es mejor escribir el comentario en una línea separada como:// almacena 3.14 en la variable pi let pi = 3.14159
- Incluso si es un solo desarrollador en un equipo y es el único que escribe el código, si no está comentado, tendrá dificultades para tratar de averiguar su propósito en el programa. Por lo tanto, utilícelo con precisión y proporcione una descripción significativa.
- Haga un comentario muy simple y significativo.
- No escriba comentarios innecesarios en su código.
- En la mayoría de los casos, utilice comentarios para explicar "por qué" en lugar de "cómo".
