Github Copilot Docs

¿Cómo documentar proyectos utilizando GitHub Copilot?

Documentar adecuadamente los proyectos es un hábito esencial que no todos los desarrolladores practican con regularidad. Pero con herramientas como GitHub Copilot, puedes hacerlo sin tanta complicación, mejorando así la comprensión y el mantenimiento a largo plazo de tu proyecto. A continuación, aprenderás a usar Copilot para explicar y documentar tu código, y algunos consejos útiles para mejorar el código cuando lo toques.

¿Cómo explicar fragmentos de código usando GitHub Copilot?

Para ilustrar esto, imagina que estás revisando un proyecto en el que te acabas de integrar y no entiendes ciertas líneas de código. Sin contexto ni referencias previas, puede ser abrumador. Allí es donde entra GitHub Copilot:

1. Selecciona el código: Busca las líneas que no comprendes, por ejemplo, líneas 11 a 13.
2. Usa Copilot Chat: Actívalo y pide que te explique el fragmento seleccionado. Puedes especificar que te lo explique en español para mayor comodidad.
3. Ejecuta la explicación: Copilot te proporcionará un desglose, incluyendo el nombre de funciones y su propósito. Por ejemplo, puedes descubrir una función que desconvierte Slog a títulos legibles, esencial para sitios web con múltiples directorios.

¿Cómo generar documentación con Copilot?

Una vez que comprendas qué hace el código, es momento de documentarlo para beneficio de todo el equipo.

1. Solicita la generación de documentación: Con el código ya entendido, pide a GitHub Copilot que genere documentación en las líneas seleccionadas.
2. Verifica el estándar del documento: Copilot utilizará un estándar particular para la documentación. Aunque inicialmente podría no estar en español, lo recomendado es documentar en inglés para estandarizar en un idioma común para el desarrollo.
3. Revisa y adapta: Verifica la descripción que te brinda Copilot. Checa detalles que incluyen qué valores recibe la función y cuál es el resultado esperado.

¿Cuál es la mejor práctica al mejorar el código?

Aprender a documentar es solo el comienzo; también es fundamental adoptar mejores prácticas para desarrollo continuo.

• Pieza tocada, pieza mejorada: Cada vez que modifiques un elemento del proyecto, aplícale mejoras. No solo documentes sino también:
  • Realiza pruebas unitarias.
  • Aplica cualquier mejora posible.

Este enfoque estratégico te ayuda a reducir la deuda técnica y mejora el proyecto con el tiempo sin requerir rescribir el código desde cero. Herramientas de inteligencia artificial como GitHub Copilot son aliados valiosos en este proceso.

¿Cuál es el impacto de las herramientas de inteligencia artificial en la documentación?

Las herramientas de inteligencia artificial están revolucionando cómo los desarrolladores manejan sus proyectos, haciendo el proceso más eficiente y preciso. Al implementar prácticas como la documentación automatizada y mejoras continuas, no solo incrementas tu eficiencia, sino que también contribuyes al desarrollo profesional propio y de tu equipo.

Te animamos a comenzar a aplicar estos conceptos utilizando GitHub Copilot. Si ya lo estás haciendo, comparte tus experiencias y resultados. ¿Cómo estás aprovechando la inteligencia artificial para mejorar tus proyectos?