Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C

comments and documentation — conceito C23

C suporta comentários de bloco `/* ... */` e de linha `// ...`; desaparecem numa fase inicial da tradução e os blocos não podem ser aninhados. A documentação deve registar contratos e motivos, não repetir código evidente.

Versão: C23

Sintaxe

comments and documentation

C suporta comentários de bloco /* ... */ e de linha // ...; desaparecem numa fase inicial da tradução e os blocos não podem ser aninhados. A documentação deve registar contratos e motivos, não repetir código evidente.

Um comentário de função deve indicar propriedade dos ponteiros, unidades de tamanho, significado do resultado e condições de falha. Dentro de um algoritmo é útil quando explica um invariante não evidente ou a razão da ordem das operações.

Um /* dentro de um bloco não abre outro nível; o primeiro */ termina tudo e pode expor código acidental. Uma macro não consegue comentar texto arbitrário com fiabilidade; usa um #if 0 controlado e mantém o texto válido para o pré-processador.

Exemplos

#include <stdio.h>

int main(void) {
    /* A block comment cannot be nested. */
    int value = 6; // The line comment ends at the newline.
    printf("%d\n", value + 1);
    return 0;
}

Resultado

7

C suporta comentários de bloco `/* ... */` e de linha `// ...`; desaparecem numa fase inicial da tradução e os blocos não podem ser aninhados. A documentação deve registar contratos e motivos, não repetir código evidente.

Fontes