Comentarios y estilo

Comentarios

Los comentarios son pequeños fragmentos de texto destinados a proporcionar información extra a la persona que está leyendo el código.

Es generalmente aceptado que los comentarios no deben ser sustituto de un código claro y que tenga un propósito claro. El código debe ser lo suficientemente entendible como para no tener que explicar su propósito. Habrá situaciones, sin embargo, en las que no habrá más remedio que explicar un proceso mediante un comentario bien realizado.

Hay dos formas de añadir comentarios en C++:

  1. Con un bloque de comentario
  2. Como una única línea

Bloque de comentario

Los bloques de comentario comienzan con ‘/*’ y acaban con ‘*/’. Todo lo que vaya entre ambos símbolos se considera comentario. Por ejemplo

/* Esto es un comentario
que ocupa varias lineas.
Los comentarios son útiles */

Comentario de una sola línea

Se puede crear un comentario de una sola línea poniendo dos ‘//’. Por ejemplo:

int main()
{
  int edad = 40;
  int anyo = 0;
  // mostrar mensaje al usuario
  std::cout << "Prueba";
  // acabar programa
  return 0;  
}

Guías de estilo

Como sucede con todos los lenguajes de programación, también en C++ hay muchas formas diferentes de escribir código. Voy a intentar permanecer constante a lo largo del curso, tratando de mostrame lo más legible posible.

Es importante señalar que a pesar de que existan muchas guías de estilo, al final lo más importante es permanecer alineado con el estilo de la gente que te está pagando.

A continuación te dejo dos guías de estilo para que tomes como ejemplo:

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.