Los comentarios sirven como una especie de documentación en el código. Cuando se insertan en un programa, el compilador los ignora de manera efectiva; están destinados únicamente a ser utilizados como notas por los humanos que leen el código fuente. Aunque la documentación específica no forma parte del estándar C++, existen varias utilidades que analizan los comentarios con diferentes formatos de documentación.

Sintaxis

/*comentario*/ (1)
//comentario (2)

1) Conocidos a menudo como comentarios de “estilo C” o “multilínea”.2) Conocidos a menudo como comentarios de “estilo C++” o “de una sola línea”.

Todos los comentarios se eliminan del programa en la fase de traducción 3 reemplazando cada comentario con un solo carácter de espacio en blanco.

estilo C

Los comentarios de estilo C generalmente se usan para comentar grandes bloques de texto, sin embargo, se pueden usar para comentar líneas individuales. Para insertar un comentario de estilo C, simplemente rodee el texto con /* y */; esto hará que el compilador ignore el contenido del comentario. Aunque no es parte del estándar C++, /** y */ a menudo se utilizan para indicar bloques de documentación; esto es legal porque el segundo asterisco simplemente se trata como parte del comentario. Los comentarios de estilo C no se pueden anidar.

estilo C++

Los comentarios de estilo C++ generalmente se usan para comentar líneas individuales; sin embargo, se pueden colocar varios comentarios de estilo C++ juntos para formar comentarios de varias líneas. Los comentarios de estilo C++ le dicen al compilador que ignore todo el contenido entre // y una nueva línea.

notas

Debido a que los comentarios se eliminan antes de la etapa de preprocesador, un macro no se puede usar para formar un comentario y un comentario de estilo C sin terminar no se desborda de un archivo #include’d.

Además de comentar, se utilizan otros mecanismos para la exclusión del código fuente.

#if0
    std::cout <<"this will not be executed or even compiledn";#endif

y.

if(false)
    std::cout <<"this will not be executedn"

Ejemplo

/* C-style comments can contain
multiple lines *//* or just one */// C++-style comments can comment one line// or, they can// be strung togetherintmain()// The below code won't be run// return 1;// The below code will be runreturn0;

Ver también