Comentários Swift

Neste artigo, você aprenderá sobre os comentários do Swift, por que e como usá-los.

Os comentários são explicações ou anotações legíveis pelo programador no código-fonte do programa. Durante a compilação do código, o compilador ignora-o.

Os comentários são para ajudar os leitores a entender melhor a intenção e a funcionalidade do programa. Ao trabalhar em equipe, pode ser útil esclarecer o propósito do código para outros membros da equipe, ou quando trabalhando sozinho, pode servir como uma lembrança.

Comentários Swift e seus tipos

Swift tem dois tipos de comentários:

1.comentários em uma linha

Em Swift, qualquer linha começando com duas barras invertidas // linhas começando com duas barras invertidas são comentários em uma linha, todos os que começam com duas barras invertidas // linhas começando com duas barras invertidas serão ignoradas pelo compilador.

Você pode encontrar um exemplo simples no topo do playground:

//: Playground　-　noun: um lugar onde as pessoas podem jogar

começando com duas barras invertidas // começando e fornecendo uma explicação significativa ao arquivo, por exemplo: "Playground" - noun: um lugar onde as pessoas podem jogar

Exemplo1: comentário em uma linha

//Programa de exemplo
//armazena　3.14　in variável pi
let pi =　3.14159　
print(pi)

O exemplo acima contém dois comentários em uma linha:

//　Programa de exemplo
//　armazena　3.14　in variável pi

2.comentários em múltiplas linhas

Se seus comentários contiverem múltiplas linhas, você pode colocá-los entre/*...*/.

Os comentários em múltiplas linhas começam com uma barra invertida (/*) , terminando com um asterisco, seguido de uma barra invertida (*/) O compilador Swift ignorará/* e */toda a conteúdo entre

/*　Este é um comentário em múltiplas linhas.
Adicione*, seguido de/para encerrá-lo
*/

Exemplo2: comentários em múltiplas linhas

/*　O valor de pi hardcoded pode não ser tão preciso.
Portanto, você pode usar tipos de dados integrados para calcular valores mais precisos.
*/
let pi = Double.pi
print(pi)

O exemplo acima contém comentários em múltiplas linhas.

/*　O valor de pi hardcoded pode não ser tão preciso.
Portanto, você pode usar tipos de dados integrados para calcular valores mais precisos.
*/

Coisas a lembrar

Embora os comentários sejam muito úteis para entender melhor a intenção do código, é importante notar que:

1. Não inclua comentários em múltiplas linhas.//Em, apesar de ser válido, o compilador ignora essas linhas. Em vez disso, deve ser colocado em comentários em múltiplas linhas./* ... */中
   Por exemplo:

   //Este é um comentário.
   //Use-o quando necessário e exatamente

   O método de escrever comentários acima é correto, mas não é recomendado fazer isso, porque se o comentário for maior que uma linha, será necessário escrever um comentário de várias linhas. A melhor maneira de escrever é usar o comentário de várias linhas como:

   /*　Este é um comentário.
   Use-o quando necessário e exatamente
   */

2. Os comentários em linha podem ser escritos em uma linha separada ou junto com o código na mesma linha. No entanto, é recomendável usar uma linha separada para comentários.
   Por exemplo:

   let pi =　3.14159　//armazena　3.14　in variável pi

   Este método de escrita de comentários é eficaz. No entanto, é melhor escrever comentários em uma linha separada:
   

   //armazena　3.14　in variável pi
   let pi =　3.14159

3. Mesmo que você seja o único desenvolvedor em uma equipe e seja o único a escrever código, se o código não tiver comentários, é difícil encontrar seu uso no programa. Portanto, use-o exatamente e forneça uma descrição significativa.

4. Faça comentários muito simples e significativos.

5. Não escreva comentários desnecessários no código.

6. Na maioria dos casos, use comentários para explicar 'por que' em vez de 'como'.