Exemplo de adição de comentários em 15 linguagens de programação

Vamos descobrir o que são comentários e porque são importantes na programação.

Também abordamos dois tipos comuns de comentários e como escrevê-los em 15 linguagens de programação diferentes.

O que são comentários na programação?

Comentários em termos leigos são pedaços de texto que não serão visíveis para usuários finais e são para referência de pessoas que estão escrevendo código.

Um pouco mais formalmente, um comentário é uma descrição de um programa sobre como ele funciona em um formato legível simples. Eles geralmente são usados ​​em locais onde alguma clareza adicional precisa ser fornecida ao desenvolvedor que está lendo o código. Assim, isso ajuda a melhorar a legibilidade do código e reduz o tempo e a comunicação que seriam necessários para a transferência de conhecimento.

O compilador/intérprete simplesmente ignora os comentários em seu código, não afetando assim a saída final de seu programa. Portanto, em poucas palavras, os comentários são como uma explicação simples e legível para certos trechos de código.

Tipos Comuns de Comentário

A maioria das linguagens de programação suporta 2 tipos de comentários.

  • Comentário de linha única
  • Comentário de várias linhas / comentários de bloco

Como o nome sugere, os comentários de uma linha são úteis quando é necessário adicionar um pequeno texto de uma linha, por exemplo. uma condição particular, um valor constante que precisa de uma pequena descrição. Considerando que multi-linha funciona melhor quando temos uma quantidade maior de informações a serem adicionadas como uma descrição sobre uma função e como se pode usá-la, etc.

  Como consertar o erro de velocidade do ventilador da CPU

Existem alguns outros tipos de comentários, como comentários de documentos, mas isso está fora do escopo deste artigo.

Por que você deve adicionar comentários?

“Qualquer tolo pode escrever um código que um computador possa entender. Bons programadores escrevem códigos que os humanos podem entender.” – Martin Fowler

A principal vantagem de adicionar comentários é a legibilidade aprimorada e melhor compreensão do programa. Além disso, algumas outras vantagens incluem –

  • Os comentários tornam super fácil para seus colegas e até mesmo outros desenvolvedores entenderem a lógica sem ler longas documentações.
  • Comunicação reduzida entre desenvolvedores para pequenas dúvidas
  • Os comentários são ignorados pelo compilador/interpretadores.
  • Para software de código aberto, eles são obrigatórios, pois você não estará lá para explicar todas as funções a milhões de desenvolvedores que desejam usar esse programa específico.

Comentários em vários idiomas

Incrível, agora que aprendemos sobre comentários e por que eles são úteis. Vamos explorar como podemos adicionar comentários em diferentes linguagens de programação.

Comentário de linha única

// This is a single line comment in C/C++

Comentário de várias linhas

/* This is slightly long
multi line comment in C/C++ */

Comentário de linha única

# This is a single line comment in Python

Comentário de várias linhas

# This is slightly long
# multi line comment in Python

Comentário de linha única

// This is a single line comment in Java

Comentário de várias linhas

/* This is slightly long
multi line comment in Java */

Comentário de linha única

# This is a single line comment in Ruby

Comentário de várias linhas

=begin 
This is slightly long
multi line comment in Ruby
=end

Comentário de linha única

// This is a single line comment in Golang

Comentário de várias linhas

/* This is slightly long
multi line comment in Golang */

Comentário de linha única

– – This is a single line comment in Haskell

Comentário de várias linhas

{- This is slightly long
multi line comment in Haskell -}

Comentário de linha única

// This is a single line comment in Rust

Comentário de várias linhas

/* This is slightly long
multi line comment in Rust */

Comentário de linha única

<!--  This is a single line comment in HTML -->

Comentário de várias linhas

<!-- This is slightly long
multi line comment in HTML -->

Comentário de linha única

/* This is a single line comment in CSS */

Comentário de várias linhas

/* This is slightly long
multi line comment in CSS */

Comentário de linha única

// This is a single line comment in Javascript

Comentário de várias linhas

/* This is slightly long
multi line comment in Javascript */

Comentário de linha única

# This is a single line comment in R programming language

Comentário de várias linhas

R não oferece suporte a comentários de várias linhas.

Comentário de linha única

% This is a single line comment in Erlang

Comentário de várias linhas

R não oferece suporte a comentários de várias linhas.

Comentário de linha única

// This is a single line comment in PHP

Comentário de várias linhas

/* This is slightly long
multi line comment in PHP */

Comentário de linha única

# This is a single line comment in Perl

Comentário de várias linhas

=begin 
This is slightly long
multi line comment in Perl
=end

Comentário de linha única

// This is a single line comment in Kotlin

Comentário de várias linhas

/* This is slightly long
multi line comment in Kotlin */

Conclusão

O tutorial abordou o básico sobre comentários e 2 tipos comuns – Simples e Multilinha. Eu também tentei explicar por que os comentários são úteis e se deve escrevê-los quando necessário. Espero que você tenha aprendido algo novo!

Continue explorando. Continue aprendendo! 👨‍💻