Comentarios en C++

Los comentarios pueden ser utilizados para resumir el código o para explicar la intención del programador. Según esta escuela de pensamiento, re-explicar el código en lenguaje natural se considera superfluo y la necesidad de volver a explicar el código puede ser un signo de que es demasiado complejo y debe ser reescrito.

“No documentes mal código – re-escríbelo. ”
“Los buenos comentarios no repiten el código, ni lo explican. Estos aclaran su intención. Los comentarios deben explicar, a un nivel de abstracción más alto que el propio código, lo que se intenta conseguir”

Los comentarios también pueden ser utilizados para explicar por qué un bloque de código no se ajusta a las convenciones o las buenas prácticas. Esto está especialmente relacionado con proyectos de escaso tiempo de desarrollo, o en la corrección de errores.

Un comentario en C++ se puede hacer de dos formas:

  • Para comentarios de una sola línea: // El comentario
  • Para comentarios de varias líneas: /* El comentario */

Ejemplo de como se debe colocar los comentarios en c++

/* Autor: Duglas Moreno
Fecha: Julio 2012 */
#include<stdio.h>
#include<conio.h>
int main()
{
//Aquí declaro mis variables
int numero=10;
printf(“%i”,numero); //esto mostrará: 10
getch();
}
Anuncios

Acerca de Duglas Moreno

Programador, y Desarrollador Web, Especialista en el diseño y desarrollo de Sistemas, aplicaciones web.
Esta entrada fue publicada en Algoritmica y Programacion I y etiquetada , , . Guarda el enlace permanente.