🍃 Documentar es una de las mejores prácticas que podemos hacer cuando estamos en un equipo de trabajo. Dejar por escrito cómo hemos hecho algunas funcionalidades, cómo podría ser mejorado el código y por sobre todo debemos dejar comentarios en el código que ayuden a las personas a ubicarse en qué parte de la aplicación están y qué hacen esas líneas de código.
Además de ayudar a las personas a ubicarse en el código y entender su funcionalidad, la documentación de código también tiene otros beneficios. Por ejemplo, puede facilitar el proceso de depuración de errores ya que permite a los desarrolladores rastrear y solucionar problemas más rápidamente. Asimismo, la documentación puede ser útil para futuros miembros del equipo que se unan al proyecto, ya que les permite comprender rápidamente cómo funciona el código y qué decisiones de diseño se tomaron en el pasado. En general, la documentación es una herramienta valiosa para mejorar la calidad del código y la eficiencia del equipo de desarrollo.
Unified modeling language
El UML (Lenguaje de Modelado Unificado) es una herramienta de modelado visual que se utiliza para describir y diseñar sistemas de software. Se utiliza para representar los diferentes aspectos de un sistema, incluyendo su estructura, comportamiento y arquitectura. El UML consta de varios tipos de diagramas, como diagramas de caso de uso, diagramas de clases, diagramas de secuencia y diagramas de estado, que se utilizan para representar diferentes aspectos del sistema. Cada tipo de diagrama se utiliza para modelar un aspecto diferente del sistema y proporciona información valiosa para los desarrolladores y otros miembros del equipo de desarrollo de software.
Herramientas de documentación
Existen diversas herramientas para la documentación de código, algunas de ellas son:
- Doxygen
- Javadoc
- Sphinx
- Gitbook
- Read the Docs
Estas herramientas te permiten generar documentación a partir del código fuente y facilitan la tarea de mantener actualizada la documentación.
