Cómo comentar el código
Los comentarios aportan claridad al código fuente en C, permitiendo que otros entiendan mejor lo que el código pretende conseguir y ayudando en gran medida a depurar el código. Los comentarios son especialmente importantes en proyectos grandes que contienen cientos o miles de líneas de código fuente o en proyectos en los que muchos contribuyentes están trabajando en el código fuente.
Un comentario comienza con un asterisco /* y termina con una barra de asterisco */ y puede estar en cualquier parte de su programa. Los comentarios pueden abarcar varias líneas dentro de su programa C. Los comentarios suelen añadirse directamente encima del código fuente de C relacionado.
Comentarios en diferentes lenguajes de programación
Los comentarios son el texto del programa que se ignora durante la ejecución del mismo. El compilador considera el comentario como un comando no ejecutable. Los comentarios se utilizan para la documentación del programa. Pueden proporcionar información, o descripción, o explicación sobre los códigos fuente o cualquier declaración utilizada en el programa. Los comentarios son información legible para el ser humano.
Los comentarios de varias líneas también se conocen como comentarios de bloque. Se utilizan para comentar varias líneas de sentencias en el programa. Los comentarios multilínea comienzan con /* y terminan con */. El texto/declaraciones/códigos escritos entre /* y */ no se ejecutarán durante la ejecución del programa.
La función de comentario también es muy utilizada por los programadores en muchos lenguajes de programación para evitar que se ejecute el código fuente. Se puede comentar una sola línea de código fuente o un bloque de código fuente. Esta característica ayudará a los programadores a encontrar errores en el programa. El lenguaje Go también soporta esta característica.
Sin comentarios en el código
Cuando la gente hace comentarios, está dando su opinión o perspectiva sobre algo en forma de observación o crítica. Los comentarios suelen ser afirmaciones breves. La palabra comentario se utiliza para una crítica más larga o un grupo de comentarios. Una persona que ofrece un comentario es un comentarista.
El comentario también se refiere a una respuesta publicada por un usuario en respuesta a un contenido en Internet. Estas respuestas suelen aparecer en la sección de comentarios de un artículo, una entrada de blog o un vídeo. Los sitios web pueden no permitir a los usuarios publicar comentarios si consideran que un tema es controvertido.
Los Indios de Cleveland han pospuesto la rueda de prensa de Terry Francona prevista para hoy, después de que el NY Times informara anoche de que el cambio de nombre del equipo es inminente. El equipo aduce “conflictos internos en la reunión”. El club no ha comentado oficialmente el informe.
Comentarios
[Nota del editor: Mientras nos tomamos un tiempo para descansar durante las vacaciones y prepararnos para el próximo año, volvemos a publicar nuestros diez mejores artículos del año. Disfruta de nuestros trabajos favoritos de este año y nos vemos en 2022].
El famoso profesor del MIT Hal Abelson dijo: “Los programas deben escribirse para que los lean las personas y, de paso, para que los ejecuten las máquinas”. Aunque puede que haya subestimado a propósito la importancia de ejecutar el código, tiene razón en que los programas tienen dos públicos muy diferentes. Los compiladores e intérpretes ignoran los comentarios y consideran que todos los programas sintácticamente correctos son igualmente fáciles de entender. Los lectores humanos son muy diferentes. Algunos programas nos resultan más difíciles de entender que otros, y recurrimos a los comentarios para que nos ayuden a entenderlos.
Aunque hay muchos recursos para ayudar a los programadores a escribir mejor código -como libros y analizadores estáticos-, hay pocos para escribir mejores comentarios. Aunque es fácil medir la cantidad de comentarios en un programa, es difícil medir la calidad, y ambas cosas no están necesariamente correlacionadas. Un mal comentario es peor que no tener ningún comentario. Como ha escrito Peter Vogel: