09 - Comentários

E aí é aquela hora da vida hoje muito bem vindo novamente o curso maratona Java aquele abraço especial para todos vocês que fazem parte do nosso grupo de membros filiados no girar eu falei que eu tinha e esse vídeo nós vamos falar sobre comentários ponha então o que que são comentários comentários são a pedaço de texto que você escreve no seu código que não afetar a o código em si eles são apenas informativos por exemplo você tem dois três tipos de comentários comentário em linha e assim táxi a Bárbara ou seja tudo que vier a

direita do Barra é um comentário então um comentário de uma linha quando você coloca comentários se você compilar você vai ver que comentário ele nem é adicionado ao byte code um as você um milhão de só para ter certeza aqui temos a última versão da boca like você pode ver que não temos absolutamente nada então comentário é algo que é para mim como desenvolvedor é para outro desenvolvedor e o segundo comentário é o comentário de múltiplas linhas que é/* se aperta a inter tem que terminar o asterisco bairro então você pode até colocar eles no

marinha só mas bom que você vai fazer comentário de uma linha não é indicado você fazer dessa forma a pena se você tiver comentado de múltiplas linhas você tem várias opções na hora de ir você pode ou ter esse ter isso aqui ou não não faz diferença Porque tudo que tiver dentro desse espaço aqui esses dois caras é bom ser ignorados no por exemplo isso é um comentário e de múltiplas linhas só posso colocar a quantidade aqui que eu quiser e tem um terceiro tipo de comentário O que é o javadoc então javadoc um comentário

oficial que ele é utilizada para descrever a sua fase e o seu método de escrever o quê que a que tá acontecendo para pessoas que estão utilizando o seu código então isso aqui é apenas quem está vindo essa tela que é o reino da vida hoje quando ela consegue ver que eu vir aqui e criar um javadoc que assim táxi/** Aí você aperta Enter ele tem que terminar dessa forma como sabe que é diferente pode ver aqui quem tarde ele mostrou um comentário aqui é um formatador agora você não consegue renderizar né porque não tem

mais colocar aqui ó Isso é um comentário eu posso precisar até HTML aqui ó é brava o DOC e só clicar agora na forma renderizada control.alt que outro lote que você vai ver aqui ele formatou a dúvida devo comentar o meu código não contanto que seja javadoc todos os outros tipos de comentários você deve evitar o máximo possível então tem um livro chamado Clean code código Limpo que desenvolvedores usa como base para desenvolver um código mais bonito e o cara lá ele é bem explícito falando que você não deve comentar porque se você está escrevendo

comentário E se ela mente significa que o seu código não está claro se sente você vai escrever então ele fala para você não escrever corte e não escrever código a comentários bobos por exemplo o que imprimir alvo você é como desenvolvedor ao ver System out println Aline você sabe que esse cara vai imprimir algo então você não precisa de escrever ao no comentário o que que aquele aquele pedaço de linha vai fazer porque está claro bom então se você tá aprendendo tudo bem mas é quando você começou a trabalhar evitem colocar comentário às vezes é

importante porque tem decisões que vão vir de cima para baixo decisões que são feitas por pelo seu gerente decisões só feita por a pessoas que estão acima que você às vezes precisa explicar né não só para você mas outra pessoa que pegar o sistema sem querer porque aquela Decisão foi feito então às vezes coloca um comentário de uma linha direto no código geralmente benéfico então tem casos que são exceções Mas no geral comentário é uma péssima prática tá eu não sei que você javadoc por que que eu já vou aqui importante por exemplo se você

for aqui na classe Spring outra classe mesmo tente Aline Só segura aqui ó esse método é em cima aperta contra o bebê ele vai te levar diretamente para o método e você pode ver que tem vários se você pode colocar link você pode definir parâmetros se você realizar esse cara aqui ó apertar no controle aqui novamente você vai ver uma a linha bem bonitinha e por que é importante porque essa documentação é o que outros desenvolvedores utilizando a o seu código em outra classe em outro arquivo vão conseguir ver então por exemplo se você voltar

aqui no Hello Davi Dojo no pentylene você precisa eu não faço ideia do que o print Aline faz então tem uma opção Zinho aqui se você apertar contra o que ele vai abrir a documentação e essa documentação que você vê aqui ó Exatamente Essa documentação que você tem que então você só tem muitas vezes isso como referência para o que uma determinada o salvado tem um determinado método vai fazer então a o meu conselho é os métodos públicos que você tem nessa classe devem ter um comentário javadoc tá então é uma é uma boa prática

tem empresas que não gosta No meu caso eu trabalhei nenhuma que o cara aquela moda tava colocando javadoc pelo código que falou que é um problema do comentário né que ele se não for analisar todas as vezes que você mexer naquela função e pode ficar depreciar ou seja Às vezes o comentário tá levando você entender algo errado porque alguém às vezes atualizar o código mas esqueceu de atualizar o comentário então esses Varia muito de um redor Mas você pode ver que todas as classes que utilizam apresenta os próprios faz isso já mas você for nesse

sangue é você também que tem comentários javadoc para tudo que é lado e o tamanho disso comentar aqui explicando o que que é a classe Trina é um com trote que ali explica o que que essa classe explica mais ou menos como funciona e o que que vai acontecer se você por exemplo utilizado a terminar essa funções estão é comentário para dedéu por quê Porque mundo inteiro precisa entender o que cada uma dessas funções cada um desses métodos aqui a fazer e eu não vou ficar comentando que um treinamento mas essa ideia geral sobre comentários

tá a foquem no javadoc e comentários de buscar as minhas Esquece isso tem que ser um comentário muito para começar suas um documento divulgar recomendada de uma linha só quando realmente forno difícil de entender então você vai falar e por exemplo Digamos que você tem que aceitar data de nascimento negativa não tem por que não faz sentido mas se tiver um sentido de acordo com uma regra de negócio escreve um comentário assim para a próxima pessoa que percorre entender porquê que aquele cara tá aceitando a por exemplo data de nascimento negativa é bom gente então

era isso que eu tinha para falar sobre comentários espero que vocês tenham gostado ele você não faz mal até mais