Comentario

Definición - ¿Qué significa comentario?

Un comentario es una construcción especial en un lenguaje de programación que permite al desarrollador del programa mencionar información adicional asociada con el programa. La razón principal para incluir comentarios en lenguajes de programación es mejorar la portabilidad y la capacidad de mantenimiento de un código.

Techinfo explica el comentario

A menudo, los equipos de desarrollo de software trabajan juntos en diferentes módulos de software, que son inspeccionados por ingenieros de pruebas durante el proceso de prueba. Durante el proceso de prueba, los ingenieros deben conocer el funcionamiento de un módulo. Por lo tanto, el desarrollador incluye comentarios para explicar el funcionamiento de un módulo en particular indicando los tipos válidos de entradas, el número de entradas, el algoritmo utilizado para el procesamiento en el módulo interno, las salidas esperadas y las condiciones de error que pueden encontrarse. durante el procesamiento.

Los comentarios también suelen proporcionar información sobre el autor del contenido, la fecha y hora en que se desarrolló y la fecha y hora de la última modificación. La cantidad de detalles a incluir es una cuestión de subjetividad. Algunos desarrolladores son conocidos por odiar los comentarios y los ven como una pérdida de tiempo. Para otros, los comentarios son una necesidad absoluta. En teoría, una organización debería establecer todos sus estándares de codificación. Aún así, por cualquier razón, cualquiera que haya heredado código de un equipo de desarrollo anterior le dirá la mayoría de las veces que el código no tiene los comentarios que le gustaría ver.