Comentarios en Swift

Los comentarios nos permiten escribir texto dentro de nuestro código que no será ejecutado, tan sólo será visible por el Programador.

Añadir un comentario

Para agregar un comentario sólo escribimos doble slash // y luego anotar la funcionalidad del código.

//Soy un comentario en swift

Se pueden poner al final de una línea de código, aislados en una línea, o agrupados en varias líneas.

var welcomeMessage = "Hola Mundo" //Mensaje de Bienvenida
print(welcomeMessage)

Comentarios multi-línea

Si se requiere hacer un comentario que ocupe varias líneas, lo recomendable es usar comentarios de multi-línea.

Para crear un comentario de multí-línea es colocar los párrafos entre /* y */

/*El siguiente bloque de código, sirve
para sumar dos valores y devolver su resultado
*/
let n1 =  3, n2 =  4
print("La suma de \(n1) + \(n2) = \(n1 + n2)"
//La suma de 3 + 4 = 7

Creando documentación

Una gran ventaja de usar comentarios es poder crear documentación, así en cualquier parte del código al usar una función, método, implementación el IDE podemos mostrar la documentación correspondiente.

Documentación de una línea

Para crear documentación de una sola línea sólo escribimos triple slash /// y a continuación anotra la documentación del código.

///Método para sumar dos valores
func suma(_ a:  Int,_ b:  Int) -> Int  {
   return a + b
}

Documentación de multiple-línea

Para realizar una documentación un poco más extensa de nuestro código y que sea multilínea, es colocar el contenido /** y */

//*Método para sumar dos valores
@a = primer valor
@b = segundo valor
@return, suma de los valores
*/
func suma(_ a:  Int,_ b:  Int) -> Int  {
   return a + b
}