Concepto de comentarios en programación informática

Los comentarios son notas de texto añadidas al programa para proporcionar información explicativa sobre el código fuente. Se utilizan en un lenguaje de programación para documentar el programa y recordar a los programadores las cosas complicadas que acaban de hacer con el código y también ayudan a la generación posterior a comprender y mantener el código. El compilador las considera sentencias no ejecutables. Diferentes lenguajes de programación utilizan una forma diferente de incluir los comentarios en el código fuente.

/* this is a comment in C. 
This comment syntax is guaranteed to
work on every compiler */
  
// This is also a comment in C
// but it might present portability challenges

<!-- This is a comment in HTML-->

Los comentarios se pueden utilizar para diversos fines, como:

1. Planificación y revisión: en los comentarios, podemos escribir el pseudocódigo que planeamos antes de escribir el código fuente. El pseudocódigo es una mezcla de lenguaje natural y lenguaje de programación de alto nivel. Esto ayuda a revisar el código fuente más fácilmente porque el pseudocódigo es más comprensible que el programa.
   Ejemplo –

   // GCD BY EUCLID'S ALGORITHM /* Euclid(m, n) {       while m does not divide n       r = n mod m       n = m       m = r       end       return m } */

   En el ejemplo anterior, he escrito el pseudocódigo de gcd en los comentarios. Esto ayudará durante la implementación del código.

2. Descripción del código: el programador utiliza la descripción del código para que otros entiendan su intención. Contiene el resumen del código.

   {     /* A Multiline Comment --            Define a variable of            string type and assign            value to it*/     string msg = "GeeksforGeeks"; }

3. Descripción algorítmica: Los comentarios se utilizan para la explicación de la metodología. Tales explicaciones pueden incluir diagramas y pruebas matemáticas formales. Esto puede constituir la explicación del código, en lugar de una aclaración de su intención. Por ejemplo, un programador puede agregar un comentario para explicar por qué se eligió una ordenación por inserción en lugar de una ordenación rápida, ya que la primera es, en teoría, más lenta que la última.

   list = [ f(b), f(b), f(c), f(d), f(a), ... ];    // Need a stable sort. Besides, // the performance really does not matter. insertion_sort(list);

4. Inclusión de recursos: los logotipos, diagramas y diagramas de flujo que consisten en construcciones de arte ASCII se pueden insertar en el código fuente con formato de comentario. Además, los avisos de derechos de autor se pueden incrustar en el código fuente como comentarios.
5. Metadatos: Los comentarios también contienen metadatos del programa. Estos metadatos ayudan en el mantenimiento del software. Los metadatos incluyen el nombre del creador de la versión original, el responsable actual del programa, los datos de cuándo se creó la primera versión, el nombre de las personas que han editado los archivos del programa hasta el momento, etc.
6. Depuración: el método de fuerza bruta es un método común de depuración. En este enfoque, se insertan declaraciones de impresión en todo el programa para imprimir los valores intermedios con la esperanza de que algunos de los valores impresos ayuden a identificar los errores. Después de hacer la depuración, comentamos esas declaraciones impresas. Por lo tanto, el comentario también se usa para la depuración.

   int fun(int m) {     int count = 0;     while (m > 10) {            // printf("m is less than 10, m=%d", m);         count++;     }     return m; }

7. Generación automática de documentación: las herramientas de programación a veces almacenan documentación y metadatos en los comentarios. Estos pueden incluir posiciones de inserción para la inclusión automática de archivos de encabezado, comandos para establecer el modo de resaltado de sintaxis del archivo o el número de revisión del archivo. Estos comentarios de control funcional también se conocen comúnmente como anotaciones. Mantener la documentación dentro de los comentarios del código fuente se considera una forma de simplificar el proceso de documentación, así como de aumentar las posibilidades de que la documentación se mantenga actualizada con los cambios en el código.
8. Alivio del estrés: comentar sobre las herramientas de desarrollo, los competidores, los empleadores, las condiciones de trabajo o la calidad del código en sí son formas de aliviar el estrés. La aparición de este fenómeno se puede ver fácilmente en los recursos en línea que rastrean las blasfemias en el código fuente.

Más información sobre Comentarios en C/C++ , Java , HTML , C#