Comentários
Q: O que um programador faz quando precisa escrever documentação para seu código?
A: Ele escreve em um arquivo Word.
Q: O que um bom programador faz quando precisa escrever documentação para seu código?
A: Ele utiliza comentários.
Vamos transformá-lo em um bom programador e também ensinar como utilizar comentários dentro do seu código. Mas antes, vamos descobrir o que são comentários:
No TypeScript, existem dois tipos de comentários:
- Podemos comentar uma linha inteira usando
//; - Também podemos comentar um bloco de código que abrange várias linhas ou um fragmento de código de uma linha usando
/* code */.
Vamos analisar um exemplo em que precisamos comentar algumas linhas e escrever comentários nelas. Reforçando, o compilador não executa nem analisa os trechos de código comentados, então podemos escrever qualquer coisa ali (exceto palavrões; minha mãe briga comigo se eu escrever isso).
12345678console.log("Hello world!") // This code performs output of information to the screen. let word : string = 'c<>definity' console.log(`Hello ${word}!`) /*This code creates a variable of type string and uses it for output to the screen. We use this variable with the required syntax and successfully display text on the screen with the variable. */
Como pode ser visto no código acima, vários trechos de texto foram comentados. Nos comentários, são escritas explicações sobre o que está acontecendo no código e o que determinadas linhas realizam. Observe que, ao comentar várias linhas, utiliza-se uma sintaxe de comentário diferente. (/* */)
Após //, tudo à direita desses caracteres é considerado comentário.
Também é possível comentar trechos de código. Por exemplo, caso haja suspeita de erro em uma linha específica, pode-se comentar essa linha e executar o código novamente para verificar possíveis erros.
123//var str = 'Hello World"; var num = 132; console.log(num/* - str*/);
Acima, trechos de código nos quais há suspeita de erros foram comentados utilizando diferentes tipos de comentários. Frequentemente identifico áreas propensas a erros no código utilizando esse método, e recomendo que faça o mesmo. Trata-se de uma habilidade útil para um bom programador.
Além disso, não se esqueça de escrever documentação para seu código. É como deixar uma garrafa de água ao lado da cama após uma noite de bebidas.
Obrigado pelo seu feedback!
Pergunte à IA
Pergunte à IA
Pergunte o que quiser ou experimente uma das perguntas sugeridas para iniciar nosso bate-papo
Can you explain the difference between single-line and multi-line comments again?
Why is it important to use comments in code?
Can you give more examples of when to use comments?
Awesome!
Completion rate improved to 2.94Comentários
Deslize para mostrar o menu
Q: O que um programador faz quando precisa escrever documentação para seu código?
A: Ele escreve em um arquivo Word.
Q: O que um bom programador faz quando precisa escrever documentação para seu código?
A: Ele utiliza comentários.
Vamos transformá-lo em um bom programador e também ensinar como utilizar comentários dentro do seu código. Mas antes, vamos descobrir o que são comentários:
No TypeScript, existem dois tipos de comentários:
- Podemos comentar uma linha inteira usando
//; - Também podemos comentar um bloco de código que abrange várias linhas ou um fragmento de código de uma linha usando
/* code */.
Vamos analisar um exemplo em que precisamos comentar algumas linhas e escrever comentários nelas. Reforçando, o compilador não executa nem analisa os trechos de código comentados, então podemos escrever qualquer coisa ali (exceto palavrões; minha mãe briga comigo se eu escrever isso).
12345678console.log("Hello world!") // This code performs output of information to the screen. let word : string = 'c<>definity' console.log(`Hello ${word}!`) /*This code creates a variable of type string and uses it for output to the screen. We use this variable with the required syntax and successfully display text on the screen with the variable. */
Como pode ser visto no código acima, vários trechos de texto foram comentados. Nos comentários, são escritas explicações sobre o que está acontecendo no código e o que determinadas linhas realizam. Observe que, ao comentar várias linhas, utiliza-se uma sintaxe de comentário diferente. (/* */)
Após //, tudo à direita desses caracteres é considerado comentário.
Também é possível comentar trechos de código. Por exemplo, caso haja suspeita de erro em uma linha específica, pode-se comentar essa linha e executar o código novamente para verificar possíveis erros.
123//var str = 'Hello World"; var num = 132; console.log(num/* - str*/);
Acima, trechos de código nos quais há suspeita de erros foram comentados utilizando diferentes tipos de comentários. Frequentemente identifico áreas propensas a erros no código utilizando esse método, e recomendo que faça o mesmo. Trata-se de uma habilidade útil para um bom programador.
Além disso, não se esqueça de escrever documentação para seu código. É como deixar uma garrafa de água ao lado da cama após uma noite de bebidas.
Obrigado pelo seu feedback!
