Pular para o conteúdo principal

Comentários em Java: como, quando e por que usá-los?

Se você está aprendendo Java, já deve ter se deparado com comentários no código. Mas será que você realmente sabe como usá-los de maneira certa?

Comentários podem transformar seu código em um material fácil de entender... ou um verdadeiro pesadelo!

Neste post, vou te mostrar os tipos comentários em Java, as boas práticas e erros comuns para que você nunca mais comenta os mesmos deslizes que muitos iniciantes cometem!

O que são comentários em Java?

Comentários são trechos de texto que podem ser inseridos no código para explicar o que ele faz. O compilador ignora esses comentários, ou seja, eles não afetam a execução do programa.

Eles são essenciais para documentar o código, tornando-o mais compreensível para você e para qualquer outra pessoa que precisar ler ou manter o projeto no futuro.

Tipos de comentários em Java

O Java oferece três tipos de comentários:

Comentários de uma linha (//)

Usados para pequenas explicações ou para desativar temporariamente uma linha de código.

Dica: use comentários curtos e diretos para explicar trechos específicos de código.

Comentários de múltiplas linhas (/* ... */)

Ótimos para explicações mais detalhadas ou para desativar blocos de código durantes testes.

Use com moderação! Se precisar de muitas explicações, prefira métodos bem nomeados e código claro.

Comentários de documentação (/** ... */)

Especiais para gerar documentação automática com o Javadoc. São usados para descrever classes, métodos e variáveis de forma profissional. 

Dica: sempre que criar métodos públicos, documente-os com Javadoc para facilitar o uso por outros desenvolvedores. 

Erros comuns ao usar comentários

Comentários óbvio demais:

Errado: o código já deixa claro que estamos somando!

Melhor forma:

Comentários desatualizados:

O comentário diz 10%, mais o código aplica 15%!

Mantenha os comentários sempre atualizados ou, melhor ainda, faço o código ser autoexplicativo!

Usar comentários de forma inteligente torna seu código mais claro e profissional. Evite comentários redundantes, mantenha boas práticas e use Javadoc para documentar códigos complexos.

Agora me conta: você já teve dificuldades para entender um código por falta de comentários? Ou já se deparou com comentários inúteis?

E se quiser ver outros conteúdos sobre Java, me diz nos comentários qual tema você quer que eu traga no blog! Vou adorar saber o que mais te interessa.


Marcadores:

Comentários

Postar um comentário

Postagens mais visitadas deste blog

Comandos básicos no Portugol Studio: LEIA e ESCREVA - a base de toda programação

Quando você está começando a aprender lógica de programação , é normal se perguntar: "Por onde eu começo de verdade?". A resposta é simples: por aquilo que todo programa faz - conversar com o usuário . E pra isso, você precisa dominar dois comandos essenciais: leia e escreva . Eles são o alicerce da sua comunicação com o computador. É como dizer: Ei computador! Mostra essa mensagem aqui ou Pede uma informação pra usuário e guarda essa resposta. Simples, poderoso e o primeiro passo para criar programas interativos de verdade! O que é o comando escreva ? O comando escreva serve para mostrar informações na tela . Ele é como um narrador do seu programa, que explica o que está acontecendo. Exemplo: Resultado no console: Você também pode exibir variáveis, textos combinados e até resultados de cálculos: E o comando leia ? Se escreva é falar, leia é ouvir . O comando leia permite que o usuário digite uma informação , e o programa guarde essa resposta em uma variável. Exemplo...
Postar um comentário
Leia mais

Instalando o Eclipse IDE no Windows: guia completo e simplificado

Se você quer desenvolver aplicações em Java, o Eclipse IDE  é uma das melhores ferramentas que você pode utilizar. Gratuito, poderoso e repleto de funcionalidades, o Eclipse é amplamente utilizado por desenvolvedores ao redor do mundo. Neste guia, você aprenderá como baixar, instalar e configurar  o Eclipse IDE no Windows , garantindo um ambiente de desenvolvimento eficiente e pronto para rodar seus projetos Java. Vamos nessa? Baixando o Eclipse IDE O primeiro passo é a versão mais recente do Eclipse. Siga os passos abaixo: Acesse o site oficial do Eclipse: https://www.eclipse.org/downloads/ .  Clique no botão "Download"  para baixar o instalador mais recente. Aguarde o download ser concluído antes de seguir para a instalação. Dica: se você deseja uma instalação mais personalizada, pode optar por baixar a versão Eclipse IDE for Java Developers , que já vem pré-configurada para desenvolvimento Java. Instalando o Eclipse IDE Após baixar o instalador, siga os passos aba...
Postar um comentário
Leia mais

Instalando o OpenJDK no Windows: guia completo e descomplicado

Se você está começando a programar em Java  ou precisa configurar um ambiente de desenvolvimento Windows , instalar o OpenJDK é um passo essencial. O OpenJDK (Java Development Kit)  é uma versão open-source do Java, amplamente usada por desenvolvedores ao redor do mundo para criar aplicações robustas e seguras. Neste tutorial, você aprenderá a instalar e configurar o OpenJDK no Windows de maneira simples, rápida e eficaz . Vamos nessa? Baixando o OpenJDK Diferente do JDK da Oracle, o OpenJDK não possui um instalador automático para Windows. Mas não se preocupe, o processo ainda é fácil! Para baixar a versão mais recente do OpenJDK, siga estes passos: Acesse o site oficial do OpenJDK: https://jdk.java.net/ . Escolha a versão desejada (recomenda-se OpenJDK 21 ou superior para suporte de longo prazo - LTS). Baixe o arquivo .zip  correspondente à sua arquitetura (geralmente x64 a maioria dos computadores). Extraindo e configurando o OpenJDK Agora que você tem o OpenJDK baixad...
Postar um comentário
Leia mais