Dominando Comentários em C: Escrevendo Notas Claras e Eficazes

O Que É um Comentário em C?

Um comentário é uma explicação ou descrição que acompanha o código fonte. Ele ajuda desenvolvedores a comunicar intenção, melhorar legibilidade e manter código ao longo do tempo. Durante a compilação, o compilador simplesmente ignora comentários, então eles não afetam performance em tempo de execução.

Em C existem dois estilos canônicos:

1. Comentários de bloco, iniciando com /* e terminando com */. Podem abranger uma única linha ou múltiplas linhas.
2. Comentários de linha única, introduzidos por //. Tudo após as duas barras nessa linha é descartado pelo compilador.

Exemplo de Comentário de Linha Única

// Este é um comentário de linha única 

Abaixo está um programa mínimo demonstrando o uso de comentário de linha única:

#include <stdio.h>
int main(void) {
    // O seguinte imprime uma saudação
    printf("Guru99");
    return 0; // Status de saída
}

Exemplo de Comentário de Múltiplas Linhas

/* Comentário de múltiplas linhas de exemplo
Linha 1
Linha 2
... */

Aqui está um snippet real que mistura comentários de bloco com comentários inline de linha única:

#include <stdio.h>
int main() {
    /* Na função main descrevo a lógica e destaco passos-chave */
    int x = 42; // x é uma variável inteira
    printf("%d", x);
    return 0;
}

Por Que Comentar?

Escrever código legível por humanos é uma pedra angular do desenvolvimento de software profissional. Comentários:

• Esclarecem lógica complexa para futuros mantenedores.
• Documentam suposições, restrições e comportamento esperado.
• Facilitam colaboração em times e projetos open-source.
• Não impactam execução do programa, mas fornecem valor de longo prazo.

Adotar hábitos disciplinados de comentário é considerado uma prática recomendada na indústria e sinaliza expertise, diligência e compromisso com qualidade.