A Importância de Comentar Código na Linguagem de Programação

Comentar o código é uma prática essencial em todas as linguagens de programação, desempenhando um papel crucial no desenvolvimento.

Comentários são trechos de texto inseridos no código-fonte que não são interpretados pelo compilador ou interpretador, sendo destinados a fornecer explicações e informações adicionais para os programadores que irão ler e manter o código no futuro. Neste artigo, exploraremos a importância de comentar dentro da linguagem de programação e os benefícios que essa prática traz para o processo de desenvolvimento de software.

Clareza e Legibilidade

Um código bem comentado é mais claro e legível. Os comentários ajudam a explicar a lógica por trás de um determinado trecho de código, detalhando a intenção do programador. Isso torna o código mais fácil de entender, mesmo para outros desenvolvedores que possam não estar familiarizados com a parte específica do sistema. A clareza proporcionada pelos comentários permite que os desenvolvedores compreendam rapidamente o propósito de cada função, método ou algoritmo, economizando tempo e minimizando erros de interpretação.

Um comentários bem detalhado podem auxiliar na identificação de trechos de código que podem ser reutilizados em outros projetos ou partes do mesmo projeto. Quando um desenvolvedor entende claramente o propósito e funcionamento de um algoritmo, função ou classe, é mais provável que consiga adaptá-lo para novos cenários de uso. Isso promove a eficiência e reduz a duplicação de esforços no desenvolvimento de software.

Cada linguagem de programação tem sua própria forma de criar comentários. Alguns exemplos comuns incluem:

JavaScript: Comentários de linha única são criados com //, e comentários de várias linhas são delimitados por /* e */.
Python: Comentários de linha única são criados com #, e não há comentários de várias linhas.
C/C++: Comentários de linha única são criados com //, e comentários de várias linhas são delimitados por /* e */.
Java: Comentários de linha única são criados com //, e comentários de várias linhas são delimitados por /* e */.
Ruby: Comentários de linha única são criados com #, e não há comentários de várias linhas.

Compartilhe

Comentários (8)

Celso Junior - 20/12/2023 21:52

No Python não se usa aspas triplas para comentar várias linhas? Podendo ser elas, simples ou duplas.

Ex:

"""

Comentário

"""

Lucas Moreira - 31/07/2023 09:40

Incrível, depois que eu aprendi sobre o mecanismo de comentário, eu deixo observações sempre que posso. Caso futuramente surja alguma dúvida, eu volto no código e tento entender o porquê daquilo. Obrigado por compartilhar com a comunidade!

Eduardo Silva - 31/07/2023 09:38

Olá, Walakys!

Li o seu artigo sobre a importância de comentar código e achei muito útil. Concordo com você que os comentários são essenciais para a clareza, legibilidade e reusabilidade do código.

Achei especialmente útil a sua discussão sobre os diferentes tipos de comentários e como eles são usados em diferentes linguagens de programação. Isso me ajudou a entender melhor como usar comentários no meu próprio código.

Obrigado por compartilhar seu conhecimento comigo!

Felipe Marçal - 31/07/2023 08:54

Olá, permita-me discordar um pouco. Recomendo a leitura do livro "Clean Code" - Robert C. Martin, comentários são desnecessários se o código está bem escrito. Clareza e legibilidade deve estar na linha de código e não nos comentários. Obviamente, isto é um processo e para se chegar lá demanda-se muito estudo, prática, tentativa e erro.

Gustavo Souza - 30/07/2023 22:33

Comentar código facilita bastante a manutenção, mas tem que ter muito cuidado, para não ficar na mira de hackers.

Alguns desenvolvedores, durante a correção de bugs, decidem comentar o código, ao invés de removê-lo. Nunca faça isso!

Já vi pessoas comentando código desnecessário, repetidos.

Código comentado até com nome do banco de dados, tabela, usuário e senha do mysql, é entregar o ouro ao bandido.

Ricardo Brandao - 30/07/2023 20:37

Estou iniciando e buscando conhecimento para conseguir migrar poara esta carreira

Leandro Santos - 30/07/2023 20:33

Antes eu não comentava nada, 3 dias depois abria o code e passava vários minutos decifrando o que aquela linha de código significava kkkkk

Thiago Sales - 30/07/2023 19:45

Thanks!

Leia a seguir

Algoritmos Genéticos: Da Biologia para o Seu Dia a DiaEric Santos - 18 de Novembro

#Machine Learning

TOP 25 ALGORITMOS | Merge SortIsadora Ariane - 18 de Novembro

#Estrutura de dados

🔹Gráfico de Pareto Usando o Dashboard IA/BI da DatabricksJúlio Droszczak - 18 de Novembro

#SQL#Databricks