La programación de comentarios , también conocida como desarrollo impulsado por comentarios (CDD), es una técnica de desarrollo de software (mayoritariamente) satírica que se basa en gran medida en comentar el código. [1]
En la programación con comentarios, las etiquetas de comentarios no se utilizan para describir lo que hace un determinado fragmento de código, sino para impedir que se ejecuten algunas partes del código. El objetivo es tener el código comentado a disposición del desarrollador en cualquier momento en que lo necesite. Esto es especialmente útil cuando los requisitos cambian rápidamente. En este caso, sucede que vuelven a versiones anteriores de sí mismos, lo que obliga al programador a volver a escribir el código o a revertir partes del código desde el repositorio de versiones, lo que llevaría más tiempo. Con la programación con comentarios, cuando surge una solicitud de reversión a una implementación anterior, el desarrollador simplemente comenta la implementación actual y descomenta la anterior. Es recomendable agregar comentarios descriptivos breves a los bloques de código comentado.
En el ámbito laboral, no se trata de quién conoce más términos de un libro de texto, sino de que nos enfrentamos a problemas que no estamos seguros de cómo resolver. Cuando otra persona lee el programa de un usuario, es importante que comprenda cómo se ha solucionado el problema y no que solo vea la solución. Incluso si alguien decide dedicarse a algo distinto a la programación informática, estará bien equipado con el hábito de comentar y mostrar a los demás cómo pensó y resolvió problemas específicos. [2]
Un uso relacionado, pero independiente y más práctico de los comentarios es la creación de fragmentos con comentarios que describen una característica (normalmente mediante etiquetas especiales ) antes del desarrollo futuro de esa característica. Por ejemplo, este proceso de programación se puede utilizar para crear un prototipo de un nuevo patrón de diseño . Esto se hace creando una nueva estructura de clases o funciones sin ninguna implementación y añadiendo la implementación en una fecha posterior.
Los estudios muestran que se utilizan principalmente dos tipos de comentarios en los programas. Los precondicionales y los poscondicionales son las dos ideas más importantes que los programadores informáticos deberían utilizar al desarrollar proyectos. Los precondicionales aparecen antes de que se haya escrito la función o el método. Se utilizan para describir lo que se supone que debe hacer cada bloque de código. Esto puede guiar a los usuarios en la dirección correcta si alguien está tratando de depurar o analizar el código. Los comentarios poscondicionales se utilizan después de que se haya escrito la función o el conjunto de declaraciones. Por lo general, se utilizan para explicar al lector por qué decidieron abordar el problema de esa manera. [3]
Ejemplo de pseudocódigo:
función onClick () { // Aquí es donde manejamos el clic del mouse. // El resultado de esta función es que se resaltará un botón. } En el ejemplo, hay una estructura alrededor de un controlador de eventos de clic . Sin embargo, se utiliza programación de comentarios en lugar de una implementación real. La idea es que se puedan escribir muchas funciones de esta manera y luego se pueda volver a trabajar y revisar el diseño sin tener que refactorizar una gran cantidad de código fuente .
MSDN Suecia produjo un vídeo para el Día de los Inocentes de 2010, donde presentó satíricamente el CDD como si fuera una metodología seria. [4]
MCT es una herramienta diseñada para programadores con el fin de ayudar a aliviar parte de la complejidad del código informático. En lugar de los comentarios normales, esta herramienta permite agregar videos, animaciones, imágenes y voces en off. Los usuarios pueden descargar este software en línea y pueden agregar estas herramientas usando el cursor para arrastrarlo sobre la línea o líneas que desean explicar. Los usuarios también pueden agregar audio o gestos con las manos como comentarios. Esto puede ayudar a explicar el razonamiento detrás de las funciones y cómo se ejecuta un programa. [5]