Comentários
P: O que um programador faz quando precisa escrever documentação para o seu código?
R: Eles escrevem em um arquivo Word.
P: O que um bom programador faz quando precisa escrever documentação para o seu código?
R: Eles usam comentários.
Vamos transformar você em um bom programador e também ensinar a usar comentários dentro do seu código. Mas primeiro, vamos descobrir o que eles são:
Em 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 única linha usando
/* código */
.
Vamos dar uma olhada em um exemplo em que precisamos comentar algumas linhas e escrever comentários nelas. Irei repetir, o compilador não irá executar ou mesmo olhar para os fragmentos de código comentados, então podemos escrever qualquer coisa lá (exceto palavrões; minha mãe me repreende se eu escrever esses).
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 você pode ver no código acima, comentamos vários fragmentos de texto. Nos comentários, escrevemos explicações sobre o que está acontecendo no código e o que certas linhas fazem. Observe que, ao comentar várias linhas, usamos uma sintaxe de comentário diferente. (/* */
)
Após //
, tudo à direita dos caracteres é comentado.
Também podemos comentar fragmentos de código. Por exemplo, se suspeitarmos de um erro em uma linha específica, podemos comentar essa linha e executar o código novamente para verificar se há erros nessa linha.
123//var str = 'Hello World"; var num = 132; console.log(num/* - str*/);
Acima, comentamos fragmentos de código nos quais suspeitamos de erros usando diferentes tipos de comentários. Pessoalmente, eu frequentemente identifico áreas propensas a erros no código usando esse método, e eu recomendo que você faça o mesmo. É uma habilidade útil para um bom programador.
Além disso, não se esqueça de escrever documentação para o seu código. É como colocar uma garrafa de água ao lado da sua cama após uma noite de bebida.
Obrigado pelo seu feedback!
Pergunte à IA
Pergunte à IA
Pergunte o que quiser ou experimente uma das perguntas sugeridas para iniciar nosso bate-papo
Awesome!
Completion rate improved to 2.94
Comentários
Deslize para mostrar o menu
P: O que um programador faz quando precisa escrever documentação para o seu código?
R: Eles escrevem em um arquivo Word.
P: O que um bom programador faz quando precisa escrever documentação para o seu código?
R: Eles usam comentários.
Vamos transformar você em um bom programador e também ensinar a usar comentários dentro do seu código. Mas primeiro, vamos descobrir o que eles são:
Em 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 única linha usando
/* código */
.
Vamos dar uma olhada em um exemplo em que precisamos comentar algumas linhas e escrever comentários nelas. Irei repetir, o compilador não irá executar ou mesmo olhar para os fragmentos de código comentados, então podemos escrever qualquer coisa lá (exceto palavrões; minha mãe me repreende se eu escrever esses).
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 você pode ver no código acima, comentamos vários fragmentos de texto. Nos comentários, escrevemos explicações sobre o que está acontecendo no código e o que certas linhas fazem. Observe que, ao comentar várias linhas, usamos uma sintaxe de comentário diferente. (/* */
)
Após //
, tudo à direita dos caracteres é comentado.
Também podemos comentar fragmentos de código. Por exemplo, se suspeitarmos de um erro em uma linha específica, podemos comentar essa linha e executar o código novamente para verificar se há erros nessa linha.
123//var str = 'Hello World"; var num = 132; console.log(num/* - str*/);
Acima, comentamos fragmentos de código nos quais suspeitamos de erros usando diferentes tipos de comentários. Pessoalmente, eu frequentemente identifico áreas propensas a erros no código usando esse método, e eu recomendo que você faça o mesmo. É uma habilidade útil para um bom programador.
Além disso, não se esqueça de escrever documentação para o seu código. É como colocar uma garrafa de água ao lado da sua cama após uma noite de bebida.
Obrigado pelo seu feedback!