Neste artigo, você aprenderá sobre os comentários do Swift, por que e como usá-los.
Um comentário é uma explicação ou anotação legível pelo programador no código-fonte de um programa. Ele é ignorado pelo compilador quando o código é compilado.
Os comentários destinam-se a quem está lendo o código para entender melhor a intenção e a funcionalidade do programa. Pode ser útil ao trabalhar em uma equipe para esclarecer a finalidade do código para outros membros da equipe ou enquanto trabalha apenas, pode funcionar como um lembrete para si mesmo.
Comentário Swift e seus tipos
No Swift, existem dois tipos de comentários:
1. Comentário de linha única
Em Swift, qualquer linha que comece com duas barras //é um comentário de uma única linha. Tudo que começa com duas barras //é ignorado pelo compilador.
Você pode encontrar um exemplo simples no topo do playground:
//: Playground - nome: um lugar onde as pessoas podem brincar
Ele começa com duas barras //e fornece uma explicação significativa do arquivo como ": Playground - nome: um lugar onde as pessoas podem brincar".
Exemplo 1: Comentário de Linha Única
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
O exemplo acima contém dois comentários de linha única:
// Programa de amostra // armazena 3,14 na variável pi
2. Comentário Multilinha
Se o seu comentário incluir várias linhas, você pode colocá-lo dentro /*… */.
Os comentários de várias linhas começam com uma barra seguida por um asterisco ( /*) e terminam com um asterisco seguido por uma barra ( */). Tudo entre /*e */é ignorado pelo compilador rápido.
/ * Este é um comentário de várias linhas. Depois de escrever um comentário multilinha, adicione * seguido de / para encerrá-lo * /
Exemplo 2: comentário multilinha
/* 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)
O exemplo acima contém um comentário de várias linhas.
/ * O valor de pi codificado pode ser menos preciso. Assim, você pode calcular usando tipos de dados integrados para um valor mais preciso * /
Coisas para lembrar
Embora os comentários sejam significativos para entender melhor a intenção do código escrito. Aqui estão as coisas que você precisa considerar ao escrevê-lo:
- Não coloque comentários com // em várias linhas, embora seja válido e o compilador ignore essas linhas. Em vez disso, coloque-o dentro de um comentário de várias linhas.
/*… */
Exemplo:// Este é um comentário. // Use-o quando necessário e com precisão
A maneira acima de escrever um comentário é correta, mas não é recomendada porque você precisa escrever comentários de várias linhas se o comentário for maior que uma linha. A melhor maneira de escrever é usando comentários multilinhas como:/ * Este é um comentário. Use-o quando necessário e com precisão * /
- O comentário de uma única linha pode ser escrito em uma linha separada ou junto com o código na mesma linha. No entanto, é recomendável usar comentários em uma linha separada.
Exemplo:deixe pi = 3,14159 // armazena 3,14 na variável pi
Esta forma de escrever comentários é válida. Mas é melhor escrever o comentário em uma linha separada como:// armazena 3,14 na variável pi let pi = 3,14159
- Mesmo se você for um único desenvolvedor em uma equipe, e você for o único que está escrevendo o código, se ele não for comentado, você terá dificuldade em tentar descobrir seu propósito no programa. Portanto, use-o com precisão e forneça uma descrição significativa.
- Faça comentários muito simples e significativos.
- Não escreva comentários desnecessários em seu código.
- Na maioria dos casos, use comentários para explicar 'por que' em vez de 'como'.
