Passez en revue les fonctionnalités « expliquer » et « document » de GitHub Copilot

  • 5 minutes

GitHub Copilot permet aux développeurs de travailler plus facilement avec du code complexe ou inconnu. Dans Visual Studio Code, les développeurs ont un accès direct à GitHub Copilot fonctionnalités qui analysent, expliquent ou documentent le code.

Analyser et expliquer le code à l’aide de GitHub Copilot

Les fonctionnalités de GitHub Copilot suivantes peuvent être utilisées pour analyser et expliquer le code :

  • Mode Demander : Utilisez la vue Conversation en mode Demander pour analyser l’ensemble de votre espace de travail et poser des questions sur les sujets de codage, les concepts de la technologie et les pratiques générales de programmation.

  • Discussion en ligne : démarrez une session de discussion en ligne directement depuis l'éditeur pour poser des questions sur des sections spécifiques du code.

  • Actions intelligentes : Exécutez l’action intelligence Expliquer pour expliquer le code sélectionné sans devoir écrire une requête.

  • Conversation rapide : Posez une question rapide et revenez à ce que vous faites.

Générer la documentation du code inline à l’aide de GitHub Copilot

Les fonctionnalités de GitHub Copilot suivantes peuvent être utilisées pour générer la documentation du code inline :

  • Mode Demander : utilisez le mode Demander à l’agent pour suggérer la documentation du code inline pour un fichier de code, une classe ou une méthode. Revoyez la documentation en ligne suggérée dans la vue de chat. Demandez des mises à jour si nécessaire dans le chat. Une fois que vous êtes satisfait de la documentation proposée, vous pouvez insérer la documentation suggérée dans le fichier de code correspondant.

  • Mode plan : utilisez le mode Plan pour créer un plan d’implémentation détaillé pour vos tâches de documentation. Le mode Plan peut être utilisé pour analyser le codebase, identifier les exigences de documentation et produire un plan pas à pas. Une fois le plan approuvé, vous pouvez le remettre au mode Agent pour l’exécution.

  • Mode agent : utilisez le mode Agent pour générer de manière autonome la documentation du code inline pour les projets, fichiers, classes ou méthodes de code spécifiés. L’agent effectue d’autres tâches pendant ou après le processus de documentation. Acceptez ou refusez les mises à jour lorsque l’agent a terminé les tâches affectées.

  • Conversation inline : utilisez une session de conversation inline pour travailler directement dans l’éditeur de code. La conversation inline est utile lorsque vous souhaitez documenter du code spécifique (classes, méthodes ou blocs de code) sans quitter l’éditeur. Vous pouvez fournir des instructions spécifiques dans l’invite ou utiliser la /doc commande barre oblique sans informations spécifiques si vous le souhaitez. Les mises à jour sont affichées dans l’éditeur de code et peuvent être acceptées ou rejetées. Vous pouvez également choisir l’option permettant de réexécuter l’invite avec ou sans mises à jour.

  • Utilisez l’action intelligente "Générer la documentation" pour créer de la documentation de code intégrée pour une classe, une méthode ou un bloc de code sélectionné. L’action intelligente Générer la documentation est utile lorsque vous n’avez pas d’exigences spécifiques qui demanderaient une requête. Les mises à jour sont affichées dans l’éditeur de code et peuvent être acceptées ou rejetées. Vous pouvez également réexécuter l’action intelligente.

Générer la documentation du projet à l’aide de GitHub Copilot

Les fonctionnalités de GitHub Copilot suivantes peuvent être utilisées pour générer la documentation du projet :

  • Mode conversation de l'agent : utilisez l'agent Ask pour analyser la base de code et comprendre les projets de code, fichiers et classes. L’agent Ask peut être utilisé pour afficher un aperçu de la documentation de projet suggérée. Passez en revue les suggestions et demandez des mises à jour ou d’autres détails si nécessaire. Insérez la documentation suggérée dans un fichier de documentation de projet (README.md).

  • Vue de conversation en mode Plan agent : Créez un plan d’implémentation détaillé pour la documentation du projet, puis passez au mode agent pour l’exécution.

  • Mode Conversation en mode Agent : générez une collection de fichiers de documentation de projet : créez/mettez à jour l’README.md, créez/mettez à jour le UsageExamples.md et créez/mettez à jour le ChangeLog.md. Incluez des liens entre les fichiers de documentation, les classes de référence croisée et les méthodes, et assurez la cohérence entre les documents.

Important

Lorsque vous utilisez la vue Conversation en mode agent, chaque instruction que vous entrez compte comme une requête premium, multipliée par le multiplicateur du modèle. GitHub Copilot peut effectuer plusieurs actions de suivi pour accomplir la tâche, mais ces actions de suivi ne comptent pas dans votre utilisation des demandes Premium. Seules les requêtes que vous saisissez sont prises en compte dans la facturation. Le nombre total de requêtes Premium utilisées dépend du nombre d’invites que vous entrez et du modèle sélectionné. Le plan gratuit pour GitHub Copilot obtient 50 demandes premium par mois. Consultez les descriptions du plan pour plus d’informations sur les limites de demande Premium pour chaque abonnement GitHub Copilot.

Résumé

GitHub Copilot vous aide à analyser et documenter votre code rapidement et avec précision. La vue de conversation, la conversation inline, les fonctionnalités de conversation rapide et d’action intelligente fournissent différents niveaux d’interaction directement dans l’environnement de Visual Studio Code.