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

CKTIS / C++

Comentários e documentação

C++ disponibiliza comentários // que se estendem até ao fim da linha e comentários de bloco /* ... */. Permitem explicar o código e escrever documentação sem executar o respetivo conteúdo. Os comentários de bloco não podem ser aninhados.

Versão: C++23; repository compiler flag, production runtime not attested

Sintaxe

// comment
/* comment */

Um comentário // termina imediatamente antes do carácter de nova linha seguinte. Um comentário /* ... */ pode abranger várias linhas e termina no primeiro */. Os comentários de bloco não se aninham: outro /* não inicia um comentário interno.

Durante a tradução, cada comentário é substituído por um espaço, enquanto os caracteres de nova linha são preservados. Assim, int/**/value separa int e value, ao passo que va/**/lue não forma o identificador value. A junção de linhas ocorre antes do reconhecimento dos comentários: um \ no fim de uma linha que contenha um comentário // pode fazer com que o comentário abranja também a linha física seguinte. Evite esta forma.

Formas de documentação como /// e /** ... */ são comentários comuns para a linguagem; a sua interpretação como documentação depende de ferramentas separadas. Prefira explicar a finalidade, os pressupostos e as limitações, em vez de repetir as instruções do código. No exemplo, o comentário /// descreve add, e o comentário de bloco separa tokens numa expressão.

Esta entrada diz respeito a C++23. A fonte fornecida é um rascunho de trabalho em evolução, não uma edição C++23 definitiva. Uma definição do modo do compilador num repositório não atesta o ambiente de execução de produção.

Exemplos

#include <iostream>

/// Return the sum of two integers.
/// Precondition: The mathematical sum of a and b is representable as int.
int add(int a, int b) {
    return a /* first operand */ + b;
}

int main() {
    // Print the result once.
    std::cout << add(2, 3) << '\n';
}

Resultado

5

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes