Revisión de las características "explain" y "document" de GitHub Copilot

  • 5 minutos

GitHub Copilot facilita a los desarrolladores trabajar con código complejo o desconocido. En Visual Studio Code, los desarrolladores tienen acceso directo a las características de GitHub Copilot que analizan, explican o documenta el código.

Análisis y explicación del código mediante GitHub Copilot

Las siguientes características de GitHub Copilot se pueden usar para analizar y explicar el código:

  • Modo de preguntas: use la vista Chat en modo de preguntas para analizar todo el área de trabajo y formular preguntas sobre temas de codificación, conceptos tecnológicos y prácticas generales de programación.

  • Chat en línea: inicie una sesión de chat en línea directamente desde el editor para preguntar sobre secciones de código específicas.

  • Acciones inteligentes: ejecute la acción inteligente de explicar para explicar el código seleccionado sin siquiera tener que escribir un mensaje.

  • Chat rápido: Haz una pregunta rápida y sigue con lo que estabas haciendo.

Generar documentación de código en línea mediante GitHub Copilot

Las siguientes funciones de GitHub Copilot pueden utilizarse para generar documentación de código en línea.

  • Modo de consulta: use el modo de consulta para sugerir documentación de código en línea para un archivo de código, una clase o un método. Revise la documentación sugerida en línea en la vista de chat. Solicite actualizaciones según sea necesario en la conversación de chat. Una vez que esté satisfecho con la documentación propuesta, puede insertar la documentación sugerida en el archivo de código correspondiente.

  • Modo de edición: Use el modo de edición para sugerir documentación de código insertado para un archivo de código, una clase o un método. Revise la documentación sugerida en el editor y navegue entre las actualizaciones recomendadas. Acepte o rechace sugerencias individuales o modifique las sugerencias según sea necesario.

  • Modo de agente: utilice el modo de agente para generar de forma autónoma documentación de código en línea para proyectos de código, archivos, clases o métodos especificados. Haga que el agente realice otras tareas durante o después del proceso de documentación. Acepte o rechace las actualizaciones cuando el agente haya completado las tareas asignadas.

  • Chat en línea: use una sesión de chat en línea para trabajar directamente en el editor de código. El chat en línea es útil cuando desea documentar código específico (clases, métodos o bloques de código) sin salir del editor. Puede proporcionar instrucciones específicas en la indicación o usar el comando de barra oblicua /doc sin información específica si lo desea. Las actualizaciones se muestran en el editor de código y se pueden aceptar o rechazar. También puede elegir la opción para volver a ejecutar el comando con o sin actualizaciones.

  • Acción inteligente 'Generar Docs': utilice la acción inteligente 'Generar Docs' para crear documentación de código en línea para una clase, un método o un bloque de código seleccionado. La acción inteligente Generar documentos es útil cuando no tiene requisitos específicos que requerirían una solicitud. Las actualizaciones se muestran en el editor de código y se pueden aceptar o rechazar. También puede volver a ejecutar la acción inteligente.

Generación de documentación del proyecto mediante GitHub Copilot

Las siguientes características de GitHub Copilot se pueden usar para generar documentación del proyecto:

  • Vista de chat en modo de pregunta: use el modo preguntar para analizar el código base y comprender los proyectos de código, los archivos y las clases. Use el modo ask para obtener una vista previa de la documentación del proyecto sugerido. Revise las sugerencias y solicite actualizaciones u otros detalles según sea necesario. Inserte la documentación sugerida en un archivo de documentación del proyecto (README.md).

  • Vista de chat en modo de edición: genere un archivo de documentación del proyecto (README.md).

  • Vista de chat en modo agente: genere una colección de archivos de documentación del proyecto: cree o actualice el README.md, cree o actualice el UsageExamples.md y cree o actualice el ChangeLog.md. Incluya vínculos entre los archivos de documentación, referencie clases y métodos, y garantice la coherencia en toda la documentación.

Importante

Cuando se usa la vista Chat en modo de agente, GitHub Copilot puede realizar varias solicitudes Premium para completar una sola tarea. Las solicitudes Premium se pueden usar mediante avisos iniciados por el usuario y acciones de seguimiento que Copilot realiza en su nombre. Las solicitudes Premium totales utilizadas dependerán de la complejidad de la tarea, del número de pasos implicados y del modelo seleccionado.

Resumen

GitHub Copilot le ayuda a analizar y documentar el código de forma rápida y precisa. Las características de la vista de chat, chat en línea, chat rápido y acción inteligente proporcionan varios niveles de interacción directamente en el entorno de Visual Studio Code.