Generación de documentación de código insertado mediante GitHub Copilot

Completado

Documentar correctamente el código crea un código base más legible y fácil de mantener que sea más fácil de entender y con el que puedan trabajar otros desarrolladores.

GitHub Copilot Chat puede ayudarle a documentar el código de forma rápida, precisa y coherente.

Cada una de las siguientes características de GitHub Copilot se puede usar para crear documentación de código insertada:

• Vista de Chat: Use la Vista de Chat en modo Preguntar, Agente o Plan.
• Chat en línea: use una sesión de chat en línea para documentar código específico (clases, métodos o bloques de código) sin salir del editor.
• Acciones inteligentes: ejecute la acción inteligente Generar documentos para explicar el código seleccionado sin tener que escribir un mensaje.

Generación de documentación de código insertado mediante la vista Chat

La vista de chat se puede usar para generar documentación de código insertada para un proyecto, un archivo de código, una clase o un método. Puede revisar la documentación sugerida y solicitar actualizaciones según sea necesario antes de actualizar el archivo de código.

Cada uno de los tres modos de la vista Chat (Preguntar, Agente y Plan) se puede usar para generar documentación de código en línea. El costo de usar el modo agente es mayor que los demás modos, lo que puede ser una consideración.

Genera documentación del código en línea usando la vista de Chat en modo Pregunta.

El modo Ask se puede usar para evaluar tu código y proponer documentación insertada en el código para proyectos, clases o métodos. Puede revisar la documentación sugerida en línea y generar actualizaciones según sea necesario antes de agregar documentación al archivo de código.

1. Abra la vista Chat en modo Preguntar.

2. Agregar contexto al indicador de chat. Por ejemplo, agregue un archivo markdown que proporcione instrucciones de documentación.

3. Ingrese una instrucción para generar documentación de código en línea. Por ejemplo, puede escribir la siguiente indicación:

   @workspace /doc Create inline code documentation for the ConsoleApp class.
   

4. Examine la documentación de código en línea sugerida en la vista del chat.

   

5. Una vez que esté satisfecho con la documentación propuesta, puede aplicar la documentación sugerida al archivo de código correspondiente.

   Mantenga el puntero del mouse sobre la documentación sugerida para ver los botones Aplicar, Insertar y Copiar . El botón Aplicar se usa para aplicar la documentación sugerida al archivo de código.

   Puede usar el botón Insertar para insertar la sugerencia en el editor en la posición actual del cursor o el botón Copiar para copiar la sugerencia en el Portapapeles.

6. Después de aplicar la documentación sugerida al archivo de código, puede navegar por las actualizaciones para aceptar, rechazar o modificar sugerencias individuales.

   

   Use las flechas arriba y abajo de la barra de menús inferior para navegar por las actualizaciones sugeridas.

   A medida que navega por las sugerencias, puede mantener o deshacer sugerencias individuales mediante el menú emergente que aparece al mantener el puntero sobre la sugerencia.

   También puede modificar manualmente las sugerencias según sea necesario.

7. Para aceptar o rechazar todas las sugerencias, seleccione el botón Mantener o Deshacer de la barra de menús inferior.

   Puede continuar actualizando la documentación según sea necesario en el editor de código.

Generación de documentación de código en línea mediante la vista de Chat en Modo Plan

La vista Chat en Modo Planificación se puede utilizar para crear un plan detallado para generar documentación de código integrada en varias partes de tu proyecto. El modo Plan analiza el código base y genera un plan paso a paso que se puede entregar al modo de agente para su ejecución.

1. Abra la vista Chat en modo Plan.

2. Introduzca un aviso que describa sus tareas de documentación en línea.

   Por ejemplo, puede escribir la siguiente indicación:

   Create a plan for adding inline code documentation to the ConsoleApp class. Document the class, its properties, and methods. Identify all files that need documentation updates.
   

3. Revise el plan de implementación.

   Después de unos instantes, el agente de planificación genera un plan en la vista de Chat. El plan proporciona un resumen general y un desglose de los pasos, incluidas las preguntas abiertas para la aclaración.

4. Una vez completado el plan, seleccione Iniciar implementación para entregar el plan al modo de agente o seleccione Abrir en el Editor para guardar el plan como un archivo Markdown para su uso posterior.

   Al seleccionar Iniciar implementación, GitHub Copilot cambia al modo de agente y comienza a agregar documentación de código insertada basada en el plan aprobado.

5. Revise los archivos actualizados en el editor. Navegue por las actualizaciones para aceptar, rechazar o modificar sugerencias individuales.

6. Para aceptar o rechazar todas las sugerencias, seleccione el botón Mantener o Deshacer de la barra de menús inferior. También puede seleccionar los botones Mantener o Deshacer en la vista Chat para aceptar o rechazar todas las sugerencias.

   Puede continuar actualizando la documentación según sea necesario en el editor de código.

Genera documentación de código en línea usando la vista de Chat en modo Agente

La vista Chat en modo agente se puede usar para generar documentación de código insertada para un proyecto, un archivo de código, una clase o un método. Puede revisar la documentación insertada sugerida y solicitar actualizaciones según sea necesario antes de actualizar el archivo de código.

1. Abra la vista Chat en modo agente.

2. Agregar contexto al indicador de chat. Por ejemplo, use el botón Asociar contexto (icono de paperclip) para agregar carpetas de código fuente al chat.

3. Ingrese una indicación que defina las tareas de documentación.

   Por ejemplo, puede escribir la siguiente indicación:

   Create inline code documentation for all C# class files in the specified context. Document the class, properties, and methods. Do not add documentation to JSON, markdown, or other file types. Do not document UnitTest project files in the Test folder. Ensure that the solution builds without errors after the documentation is added.
   

   El modo de agente no admite el participante de chat @workspace ni el comando de barra oblicua /doc, por lo que debe proporcionar una indicación detallada.

4. El agente muestra los mensajes de estado en la vista Chat a medida que completa las tareas solicitadas.

   

   El agente también puede solicitar más contexto o solicitar ayuda para completar las tareas solicitadas. Por ejemplo, el agente puede solicitar permiso antes de ejecutar un comando en el terminal.

5. Espere a que el agente complete las tareas de documentación solicitadas y, a continuación, que el editor revise los archivos actualizados.

   

   Cuando finaliza el modo agente, muestra un resumen de las tareas que completó. Puede revisar los archivos actualizados en el editor.

6. Navegue por las actualizaciones para aceptar, rechazar o modificar sugerencias individuales.

   Para aceptar o rechazar todas las sugerencias, seleccione el botón Mantener o Deshacer de la barra de menús inferior. También puede seleccionar los botones Mantener o Deshacer en la vista Chat para aceptar o rechazar todas las sugerencias.

   Puede continuar actualizando la documentación según sea necesario en el editor de código.

Generar documentación de código en línea mediante la acción inteligente "Generar Docs"

La acción inteligente Generar documentos se puede usar para generar documentación de código insertada para clases, métodos o bloques de código complejos. Es una manera rápida de generar documentación sin necesidad de escribir un mensaje. La acción inteligente Generar documentos está disponible en el menú contextual al hacer clic con el botón derecho en el código seleccionado en el editor.

La acción inteligente Generar Documentos sugiere documentación de código en línea directamente en el editor de código.

1. Abra el archivo de código en el editor.

2. Seleccione el código que desea documentar.

3. Haga clic con el botón derecho en el código seleccionado, seleccione Copilot y seleccione la acción inteligente Generate Docs.

   

4. Revise la documentación de código insertado sugerida en el editor.

   

5. Use el botón Aceptar para aceptar la actualización sugerida o Cerrar para rechazar la actualización.

   También puede usar el botón Volver a ejecutar para repetir el mensaje con o sin actualizaciones.

Generación de documentación de código insertado mediante chat insertado

La característica de chat en línea se puede usar para generar documentación de código insertada para clases, métodos o bloques de código complejos. El mensaje se usa para especificar el contexto o para proporcionar instrucciones específicas. También puede usar el comando de barra oblicua /doc sin una indicación de texto si lo desea.

El chat insertado sugiere documentación de código insertado directamente en el editor de código.

1. Abra el archivo de código en el editor.

2. Seleccione el código que desea documentar.

3. Inicie una sesión de chat en línea.

   Use el método abreviado de teclado Ctrl+I o seleccione el Editor Inline Chat (Chat en línea) en el menú Chat (Chat ).

4. Ingrese una instrucción para generar documentación de código en línea.

   Por ejemplo, puede documentar un método y solicitar detalles específicos:

   Document the selected method. List currentState options
   

5. Revise la documentación de código insertado sugerida en el editor.

   

6. Use el botón Aceptar para aceptar la actualización sugerida o Cerrar para rechazar la actualización.

   También puede usar el botón Volver a ejecutar para repetir el mensaje con o sin actualizaciones.

Resumen

GitHub Copilot le ayuda a generar documentación de código en línea rápidamente y con precisión. Las características de la vista Chat, chat en línea y acción inteligente proporcionan varios niveles de interacción directamente dentro del entorno de Visual Studio Code.