Comments

Los comentarios sirven como una especie de documentación dentro del código. Cuando se insertan en un programa, el compilador los ignora efectivamente; 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 de C++, existen varias utilidades que analizan comentarios con diferentes formatos de documentación.

Sintaxis

Todos los comentarios son eliminados del programa en la fase de traducción 3 reemplazando cada comentario con un único carácter de espacio en blanco.

Estilo C

Los comentarios de estilo C se utilizan generalmente para comentar grandes bloques de texto, sin embargo, pueden usarse para comentar líneas individuales. Para insertar un comentario de estilo C, simplemente rodee el texto con /* y */ ; esto hará que el contenido del comentario sea ignorado por el compilador. Aunque no es parte del estándar de C++, /** y */ se utilizan frecuentemente 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 pueden anidarse.

Estilo C++

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

Notas

Debido a que los comentarios son eliminados antes de la etapa del preprocesador, una macro no puede utilizarse para formar un comentario y un comentario de estilo C sin terminar no se extiende desde un archivo #include'd.

Además de comentar, otros mecanismos utilizados para la exclusión de código fuente son

#if 0
    std::cout << "esto no se ejecutará ni siquiera se compilará\n";
#endif

y

if (false)
{
    std::cout << "esto no se ejecutará\n";
}

Ejemplo

#include <iostream>
/* C-style comments can contain
multiple lines */
/* or just one */
/**************
 *  you can insert any *, but
 *  you can't make comments nested
 */
// C++-style comments can comment one line
// or, they can
// be strung together
int main()
{
    // comments are removed before preprocessing,
    // so ABC is "1", not "1//2134", and "1 hello world"
    // will be printed
#define ABC 1//2134
    std::cout << ABC << " hello world\n";
    // The below code won't be run
    // return 1;
    // The below code will be run
    return 0;
}

1 hello world

Véase también