Un programa bien documentado es una buena práctica como programador. Hace que un programa sea más legible y que la búsqueda de errores sea más fácil. Una parte importante de una buena documentación son los Comentarios.
- En la programación de computadoras, un comentario es una explicación o anotación legible por el programador en el código fuente de un programa de computadora.
- Los comentarios son declaraciones que no son ejecutadas por el compilador y el intérprete.
En C/C++ hay dos tipos de comentarios:
- Comentario de una sola línea
- comentario de varias líneas
Comentario de una sola línea
Representado como // doble barra diagonal
Se utiliza para indicar un comentario de una sola línea. Aplica comentario a una sola línea solamente. Se conoce como comentarios de estilo C++, ya que originalmente es parte de la programación de C++.
por ejemplo:
// single line comment
Ejemplo: este ejemplo es el mismo para C y C++, ya que el estilo de comentario sigue siendo el mismo para ambos idiomas.
C++
// C++ program to illustrate
// use of single-line comment
#include <iostream>
int main()
{
// Single line Welcome user comment
std::cout << "Welcome to GeeksforGeeks";
return 0;
}
// This code is contributed by sarajadhav12052009
C
// C program to illustrate
// use of single-line comment
#include <stdio.h>
int main(void)
{
// Single line Welcome user comment
printf("Welcome to GeeksforGeeks");
return 0;
}
Welcome to GeeksforGeeks
comentario de varias líneas
Representado como /* cualquier_texto */ comienza con una barra inclinada y un asterisco (/*) y termina con un asterisco y una barra inclinada (*/).
Se utiliza para denotar un comentario de varias líneas. Puede aplicar comentarios a más de una sola línea. Se conoce como comentario de estilo C, ya que se introdujo en la programación C.
/*Comment starts continues continues . . . Comment ends*/
Ejemplo: este ejemplo es el mismo para C y C++, ya que el estilo de comentario sigue siendo el mismo para ambos idiomas.
C++
/* C++ program to illustrate
use of
multi-line comment */
#include <iostream>
int main()
{
/* Multi-line Welcome user comment
written to demonstrate comments
in C/C++ */
std::cout << "Welcome to GeeksforGeeks";
return 0;
}
// This code is contributed by sarajadhav12052009
C
/* C program to illustrate
use of
multi-line comment */
#include <stdio.h>
int main(void)
{
/* Multi-line Welcome user comment
written to demonstrate comments
in C/C++ */
printf("Welcome to GeeksforGeeks");
return 0;
}
Welcome to GeeksforGeeks
Comentario al final de la línea de código
También puede crear un comentario que se muestre al final de una línea de código. Pero generalmente es una mejor práctica poner el comentario antes de la línea de código.
Ejemplo: este ejemplo es el mismo para C y C++, ya que el estilo de comentario sigue siendo el mismo para ambos idiomas.
int age; // age of the person
¿Cuándo y por qué usar comentarios en la programación?
- Una persona que lea un código grande se sorprenderá si no se proporcionan comentarios sobre los detalles del programa.
- Los comentarios son una forma de hacer que un código sea más legible proporcionando más descripción.
- Los comentarios pueden incluir una descripción de un algoritmo para que el código sea comprensible.
- Los comentarios también pueden ser útiles para uno mismo si el código se va a reutilizar después de un largo intervalo.