Documentacion de Codigo

Documentacion

De codigo

Índice

Que es y para que?

Herramientas

Como Documentar

Generadores de documentos

Ejemplos

Como escribir una buena documentación

Cuando documentar?

Beneficios y Recomendaciones

Qué es, y para que documentar?

Documentar un código de programa es añadir la información suficiente que pueda explicar lo que realiza cada trozo, línea o sección.

Como documentar?

Para documentar existen diferentes métodos y depende del lenguaje, pero documentar no solo es escribir texto en ocasiones los gráficos ayudan mucho a comprender como funcionan el programa realizado.

+ info

JavaScript

Python

Cuando documentar?

Lo ideal seria documentar una vez se termina de escribir el codigo, sin embargo esto no suele suceder de esta manera, pero es importante documentar lo que se realizo asi sea al final, ya que esto nos facilita la vida a la hora de empezar a desarollar.

Beneficios y Recomendaciones

Al documentar es necesario tener encuenta algunos pasos importantes:

• Generar sólo la documentación necesaria, la realmente valiosa, la imprescindible.
• Preguntarse al comentar, ¿aporta algo de verdad?, ¿es totalmente necesario?, ¿tiene que ser tan extenso?
• Mantén un estándar al documentar código
• No olvidar revisar los comentarios cuando se modifica un programa, deben estar actualizados.

La mayoría de lo que te he mencionado hasta ahora es trabajo adicional a la creación de código. Sin embargo, no hay que verlo como un gasto de tiempo y dinero, sino como una inversión.Algunos de los beneficios de documentar código son:

• Ahorro de tiempo de desarrollo a mediano plazo
• Agilidad en el desarrollo
• Evitar creación de código duplicado
• Modularidad
• Escalabilidad
• Fácil identificación de errores

Herramientas

Doxygen

JsDoc

Doxygen es un generador de documentación para C++, C, Java, Objective-C, Python, IDL, VHDL y en cierta medida para PHP, C# y D.

Es una sintaxis para agregar documentación de la API al código fuente de JavaScript.

Es posible usar herramientas para extraer los comentarios del código y generar automáticamente la documentación del software, tambine hay herramientas con IA que nos facilitan la escritura de comentarios.

Mintlify

Natural Docs

Natural Docs es un generador de documentación multi-lenguaje.

Cree la documentación que siempre ha deseado. Hermoso listo para usar, fácil de mantener y optimizado para la participación del usuario.

+ info

Generadores de documentos