CKTIS / C++
Comentarios y documentación
C++ ofrece comentarios // que se extienden hasta el final de la línea y comentarios de bloque /* ... */. Permiten explicar el código y escribir documentación sin ejecutar su contenido. Los comentarios de bloque no pueden anidarse.
Versión: C++23; repository compiler flag, production runtime not attested
Sintaxis
// comment
/* comment */Un comentario // termina justo antes del siguiente carácter de nueva línea. Un comentario /* ... */ puede abarcar varias líneas y termina en el primer */. Los comentarios de bloque no se anidan: otro /* no inicia un comentario interno.
Durante la traducción, cada comentario se sustituye por un espacio, mientras que se conservan los caracteres de nueva línea. Así, int/**/value separa int y value, mientras que va/**/lue no forma el identificador value. La unión de líneas se produce antes de reconocer los comentarios: un \ al final de una línea que contiene un comentario // puede hacer que el comentario abarque también la siguiente línea física. Evita esta escritura.
Las formas de documentación como /// y /** ... */ son comentarios normales para el lenguaje; su interpretación como documentación depende de herramientas independientes. Es preferible explicar el propósito, las suposiciones y las limitaciones, en vez de repetir las instrucciones del código. En el ejemplo, el comentario /// describe add, y el comentario de bloque separa tokens en una expresión.
Esta entrada se refiere a C++23. La fuente proporcionada es un borrador de trabajo en evolución, no una edición C++23 definitiva. Una configuración del modo del compilador en un repositorio no acredita el entorno de ejecución de producción.
Ejemplos
#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
El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.