Comentarios
Los comentarios sirven para documentar adecuadamente el código. Cuando se insertan en un programa, son ignorados por el compilador. Están únicamente destinados a ser utilizados como notas para los seres humanos que leen el código fuente. Aunque en la documentación específica no son parte del C++ estándar, existen varias utilidades que transforman los comentarios en diferentes formatos para servir de documentación.
Contenido |
[editar] Sintaxis
/* comment */
|
(1) | ||||||||
// comment
|
(2) | ||||||||
1) A menudo conocido como comentario de "tipo C" o "multilínea". 2) A menudo conocido como comentario de "tipo C++" o de "una sola línea".
Se eliminan todos los comentarios en la fase 3 de traducción sustituyendo cada comentario por un carácter de espacio en blanco.
[editar] Tipo C
Los comentarios de tipo C se utilizan generalmente para comentar grandes bloques de texto, sin embargo, tambien se puede utilizar para comentar líneas simples. Para insertar un comentario de tipo C, simplemente hay que rodear el texto con /*
y */
, lo que hará que el contenido del comentario sea ignorado por el compilador. Aunque no es parte del estándar C + +, y /**
*/
se utilizan a menudo para indicar los bloques de documentación, lo que está permitido porque el segundo asterisco simplemente se trata como parte del comentario. El tipo de comentarios de C no puede anidarse .
Los comentarios de tipo C se prefieren a menudo en entornos en los que C y C ++ se pueden mezclar, porque son la única forma de comentario que puede ser utilizado en el estándar de C (antes de C99) .
[editar] Tipo C++
Los comentarios de tipo C++ se utilizan generalmente para hacer comentarios de líneas simples, sin embargo, varios comentarios de tipo C++ pueden colocarse juntos para formar comentarios multilínea. Los comentarios de tipo C++ indican al compilador que ignore todos los contenidos entre //
y una nueva línea, lo que los hace muy útiles .
[editar] Notas
Como los comentarios se eliminan antes de la etapa de preprocesador, una macro no se puede usar para formar un comentario y un comentario estilo C sin terminación no se extiende desde un archivo incluido (#include).
Además de los comentarios, otros mecanismos utilizados para excluir código fuente son
#if 0 std::cout << "esto no será ejecutado ni compilado\n"; #endif
y
if(false) { std::cout << "esto no se ejecutará\n" }
[editar] Ejemplo
/* Los comentarios de tipo C pueden comentar múltiples líneas */ /* o sólo una */ // Los comentarios de tipo C++ pueden comentar una línea // o pueden juntarse // en varias líneas int main() { // El siguiente código no se ejecutará // return 1; // El siguiente código se ejecutará return 0; }
[editar] Ver también
Documentación de C para comentario
|