Vamos explorar o conceito de comentários em programação e sua relevância.
Analisaremos também as duas categorias mais comuns de comentários e demonstraremos como utilizá-los em 15 linguagens de programação distintas.
O que são Comentários em Programação?
Em termos simples, comentários são trechos de texto que não são exibidos para o usuário final, servindo como anotações para os programadores que estão desenvolvendo o código.
De maneira mais formal, um comentário é uma descrição em linguagem clara e acessível sobre o funcionamento de um programa. Eles são geralmente inseridos em pontos onde uma explicação adicional se faz necessária para o desenvolvedor que está analisando o código. Assim, a legibilidade do código é aprimorada e o tempo e a comunicação necessários para a transferência de conhecimento são reduzidos.
O compilador ou interpretador ignora os comentários, sem que isso afete a saída final do programa. Portanto, em resumo, comentários são como uma explicação concisa e legível de partes específicas do código.
Tipos Comuns de Comentários
A maioria das linguagens de programação oferece suporte a dois tipos de comentários.
- Comentários de linha única
- Comentários de múltiplas linhas (ou blocos)
Como o próprio nome sugere, os comentários de linha única são ideais para pequenas notas em uma única linha, por exemplo, uma condição particular ou a descrição de um valor constante. Já os comentários de múltiplas linhas são mais adequados para informações mais extensas, como descrições detalhadas de uma função e sua forma de utilização.
Existem outros tipos de comentários, como os comentários de documentação, mas estes estão fora do escopo deste artigo.
Por que Utilizar Comentários?
“Qualquer principiante pode escrever um código que um computador compreenda. Bons programadores escrevem códigos que os humanos podem entender.” – Martin Fowler
O maior benefício de adicionar comentários é a clareza e a facilidade de compreensão do programa. Além disso, outras vantagens incluem:
- Comentários facilitam a compreensão da lógica do código por outros desenvolvedores sem a necessidade de extensas documentações.
- Redução da necessidade de comunicação entre desenvolvedores para dúvidas pontuais.
- Comentários são ignorados por compiladores e interpretadores.
- Em projetos de código aberto, comentários são essenciais para que os desenvolvedores possam entender as funções sem a presença do criador do código.
Comentários em Diferentes Linguagens
Agora que entendemos o que são comentários e sua importância, vamos explorar como adicioná-los em diversas linguagens de programação.
Comentário de linha única
// Este é um comentário de linha única em C/C++
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em C/C++ */
Comentário de linha única
# Este é um comentário de linha única em Python
Comentário de várias linhas
# Este é um comentário de múltiplas linhas um pouco mais longo em Python # que ocupa várias linhas
Comentário de linha única
// Este é um comentário de linha única em Java
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em Java */
Comentário de linha única
# Este é um comentário de linha única em Ruby
Comentário de várias linhas
=begin Este é um comentário de múltiplas linhas um pouco mais longo em Ruby =end
Comentário de linha única
// Este é um comentário de linha única em Golang
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em Golang */
Comentário de linha única
-- Este é um comentário de linha única em Haskell
Comentário de várias linhas
{- Este é um comentário de múltiplas linhas um pouco mais longo em Haskell -}
Comentário de linha única
// Este é um comentário de linha única em Rust
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em Rust */
Comentário de linha única
<!-- Este é um comentário de linha única em HTML -->
Comentário de várias linhas
<!-- Este é um comentário de múltiplas linhas um pouco mais longo em HTML -->
Comentário de linha única
/* Este é um comentário de linha única em CSS */
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em CSS */
Comentário de linha única
// Este é um comentário de linha única em Javascript
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em Javascript */
Comentário de linha única
# Este é um comentário de linha única na linguagem R
Comentário de várias linhas
A linguagem R não suporta comentários de múltiplas linhas.
Comentário de linha única
% Este é um comentário de linha única em Erlang
Comentário de várias linhas
Erlang não oferece suporte a comentários de múltiplas linhas.
Comentário de linha única
// Este é um comentário de linha única em PHP
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em PHP */
Comentário de linha única
# Este é um comentário de linha única em Perl
Comentário de várias linhas
=begin Este é um comentário de múltiplas linhas um pouco mais longo em Perl =end
Comentário de linha única
// Este é um comentário de linha única em Kotlin
Comentário de várias linhas
/* Este é um comentário de múltiplas linhas um pouco mais longo em Kotlin */
Conclusão
Este guia abordou o básico sobre comentários e seus dois tipos principais: linha única e múltiplas linhas. Também destacamos a importância de utilizá-los. Esperamos que você tenha aprendido algo de valor!
Continue explorando. Continue aprendendo! 👨💻