Si te preguntas cómo es la mente del programador/a. 😂
Déjame decirte que documentar el código va más allá de simplemente agregar comentarios aleatorios. Existen dos tipos de documentación en un proyecto de software: la externa, que incluye requerimientos, diagramas, estándares, etc., y la interna, que reside en el código y guía a los programadores durante las fases de prueba y mantenimiento.Nos centraremos en la segunda.
Los comentarios son parte de la documentación, pero no lo abarcan todo.
Un buen proyecto debe contener buena estructura, uso de nombres adecuados en variables, código limpio, rutinas, metodologías adecuadas, etc.
➡️Existen varios tipos comentarios: repetitivos del código, explicativos del código, marcadores en el código, resumen del código, descriptivos del propósito del código. (Solo te explicaré algunos). Y bueno Vanessa, ¿eso qué es?, te lo explico.
✔️Repetitivos del código: Son aquellos que replantean lo que el código dice en lenguaje común, proporcionan al lector información adicional.
✔️Explicativos del código: se utilizan para explicar piezas de código que pueden ser complicadas o sensibles. Eso permite minimizar la complejidad y hacer más claro nuestro código.
✔️Marcadores en el código: Se colocan a la izquierda de nuestro código. Son notas que indican que el trabajo aún no está concluido. Puede ser mediante una instrucción de sintaxis incorrecta para que nuestro compilador lo detecte o caracteres como un comentario que localice y no interfiera a la hora de compilar.
✔️Resumen del código: Debes en una o dos líneas resumir algún grupo de sentencias. Son útiles porque se evita la repetición y alguien distinto a ti puede entenderlos a la hora de modificar el código.
✔️Descriptivos del propósito del código: Son los que explican la intención de una sección de código. Son los que operan más a nivel del problema que a nivel de solución.
Al adoptar prácticas sólidas de documentación, no solo estamos construyendo un código más comprensible para nosotros mismos, sino también para los miembros del equipo y cualquier colaborador futuro. Documentar se refleja no solo en el código que se escribe, sino en la claridad y coherencia con la que se documenta cada aspecto.
👉Comparto contenido variado. Puedes encontrar recursos de programación, inglés, etc.
Vanessa Marlene Sanchez
#meme #documentation #documentacion