Utiliser la personnalisation du code Gemini Code Assist

Ce document explique comment utiliser la personnalisation du code Gemini Code Assist et fournit quelques bonnes pratiques. Cette fonctionnalité vous permet de recevoir des recommandations de code basées sur les bibliothèques internes, les API privées et le style de codage de votre organisation.

Avant de commencer

  1. Configurez Gemini Code Assist avec un abonnement Enterprise.
  2. Configurez la personnalisation du code Gemini Code Assist.

Utiliser la fonctionnalité de personnalisation du code

Le tableau suivant recense les différentes façons d'utiliser la fonctionnalité de personnalisation du code Gemini Code Assist :

Formulaire Comment déclencher Remarques et ressources

Chat en langage naturel

Saisissez un prompt en langage naturel dans le chat Gemini Code Assist de l'IDE.

Réfléchissez aux éléments suivants :

  • L'historique des chats n'est pas disponible. Évitez les requêtes en plusieurs étapes.
  • Vous pouvez demander plus d'informations sur les sources, y compris des liens vers les sources spécifiques.
  • Si vous mettez en surbrillance ou sélectionnez du code lorsque vous envoyez un message dans le chat, Gemini Code Assist utilise ce code pour améliorer la personnalisation du code et la qualité du chat.

Pour en savoir plus, consultez Discuter avec Gemini Code Assist.
Générer du code Dans la barre de sélection rapide de votre IDE, avec ou sans code sélectionné, appuyez sur Command+Entrée (sous macOS) ou Control+Entrée (sous Windows). Pour en savoir plus, consultez Générer du code avec des prompts.
Transformer du code Dans la barre de sélection rapide de votre IDE, avec ou sans code sélectionné, saisissez /fix. Pour en savoir plus, consultez Générer du code avec des prompts.
Saisie semi-automatique La personnalisation du code est déclenchée automatiquement et fournit des suggestions en fonction de ce que vous écrivez.

Réfléchissez aux éléments suivants :

  • La complétion de code a besoin d'un certain niveau de confiance pour proposer une suggestion. Veillez à ce qu'une grande quantité de code soit disponible afin de permettre l'extraction des extraits pertinents.
  • La complétion de code vérifie si vous disposez des bibliothèques requises pour utiliser certains éléments de la fonction.

Pour en savoir plus, consultez la section Obtenir des complétions de code.

Contexte du dépôt distant
  1. Commencez votre requête par le symbole @. Une liste des dépôts distants indexés disponibles s'affiche.
  2. Dans la liste, sélectionnez le dépôt que vous souhaitez utiliser pour le contexte. Vous pouvez également commencer à saisir le nom du dépôt pour filtrer la liste.
  3. Après avoir sélectionné le dépôt, rédigez le reste de votre requête.

Réfléchissez aux éléments suivants :

  • Cela est utile lorsque vous travaillez sur une tâche qui est principalement liée à un ensemble spécifique de microservices, de bibliothèques ou de modules.

Pour en savoir plus, consultez Obtenir des suggestions plus pertinentes grâce au contexte du dépôt distant.

Cas d'utilisation et exemples de prompts

Le tableau suivant fournit des conseils et des exemples d'utilisation de la personnalisation du code dans des cas d'utilisation spécifiques :

Cas d'utilisation Conseils et exemples d'utilisation
Écrire du code

Essayez les méthodes suivantes pour générer du code dans votre IDE ou dans le chat Gemini Code Assist :

  • Générez du code qui utilise des termes déjà mentionnés dans votre codebase.
  • Collez votre code, comme une signature fonctionnelle ou un code avec des commentaires TODO, puis demandez à Gemini Code Assist de remplir ou de remplacer les commentaires TODO par du code. Ajoutez des commentaires avec des explications à partir du contexte.

Essayez de générer du code avec les prompts suivants dans le chat Gemini Code Assist :

  • "Écris une fonction principale où une connexion à DATABASE est créée. Inclus des vérifications de l'état."
  • "Écris une FUNCTION_OR_CLASS en respectant la structure suivante : EXPLAIN_STRUCTURE."

Après avoir généré du code, essayez d'utiliser un prompt complémentaire pour l'améliorer :

  • "Exécute la commande /fix pour ajuster le code généré (par exemple, les erreurs de syntaxe)."
  • "Ajoute les importations manquantes"
  • "Exécute la commande /fix sur le code généré par le chat."
Nettoyer, simplifier et refactoriser le code

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Peux-tu fusionner IMPORTS_VARIABLES_OR_NOTE_EXPORTED_FUNCTIONS dans ce fichier ?"
  • "Comment simplifier la fonction FUNCTION_NAME ?"
  • "Peux-tu fusionner FUNCTION_NAME_1 et FUNCTION_NAME_2 en une seule fonction ?"
  • "Peux-tu intégrer certaines variables dans FUNCTION_NAME ?"
  • "Peux-tu simplifier le nommage des variables dans la fonction FUNCTION_NAME ?"
Lisibilité

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Écris la fonction FUNCTION_NAME avec moins de lignes de code, si possible."
  • "Ajoute des commentaires à la fonction FUNCTION_NAME."
  • "Supprime les espaces inutiles dans la fonction FUNCTION_NAME."
  • "Mets en forme la fonction FUNCTION_NAME de la même manière que le reste du code."
Révision du code

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Divise le code en parties et explique chacune d'elles en utilisant notre codebase."
  • "Existe-t-il des variables ou des mots clés qui pourraient être plus courts et plus explicites ?"
  • "Peux-tu me donner du code utile à partir du contexte REPOSITORY_NAME_PACKAGE_MODULE pour ce code ?"
  • "Que penses-tu de la fonction FUNCTION_NAME ?"
Débogage

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Je reçois un message d'erreur lorsque j'essaie de faire X/d'ajouter Y. Pourquoi ?"
  • "Peux-tu repérer une erreur dans la fonction FUNCTION_NAME ?"
  • "Comment corrigerais-tu la fonction FUNCTION_NAME étant donné ce message d'erreur ?"
Apprentissage et intégration

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Divise ce code en parties et explique chacune d'elles en utilisant notre codebase."
  • "Montre-moi comment appeler la fonction FUNCTION_NAME ?"
  • "Montre-moi comment exécuter la fonction principale dans l'environnement ENVIRONMENT_NAME."
  • "Quelle est la principale amélioration technique que je peux apporter à ce code pour le rendre plus performant ?"
  • "Montre-moi l'implémentation de FUNCTION_OR_CLASS_NAME pour obtenir de meilleurs résultats et ajoute ce qu'est cet élément spécifique". Exemple : "Montre-moi l'implémentation de la fonction foo où foo est le nom de la fonction".
Migration

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Donne-moi une stratégie pour migrer FILE_NAME de LANGUAGE_1 vers LANGUAGE_2" (par exemple, de Go vers Python).
  • "Étant donné la fonction FUNCTION_NAME dans le dépôt REPOSITORY_NAME, trouve-moi une fonction équivalente dans le langage LANGUAGE_NAME que je peux utiliser."

Essayez le workflow de transformation basé sur le chat ou la génération de code suivant à l'aide de prompts :

  1. "Prends le code FILENAME_COMPONENT déjà écrit en LANGUAGE_1, refactorise-le et migre-le vers LANGUAGE_2" (par exemple, de Go vers Python).
  2. Après avoir migré du code, essayez ce qui suit :
    • Sélectionnez des blocs plus petits et utilisez /fix pour obtenir l'état souhaité.
    • Essayez les prompts suivants :
      • "Y a-t-il quelque chose qui peut être amélioré ?"
      • "Donne-moi les éventuels points faibles."
      • "Comment testerais-tu ce code pour vérifier que la migration est correcte ?"
Générer de la documentation

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Résume le code du package ou du dossier X et fournis la documentation pour les cinq méthodes les plus importantes."
  • "Génère la documentation pour FUNCTION_OR_CLASS_NAME."
  • "Raccourcis la documentation tout en conservant les informations clés."
Générer des tests unitaires

Essayez les requêtes suivantes dans le chat Gemini Code Assist :

  • "Génère des tests unitaires pour FILENAME."
  • "Ajoute les scénarios de test les plus pertinents pour la fonction FUNCTION_NAME."
  • "Supprime les scénarios de test qui, selon toi, n'apportent pas beaucoup de valeur."

Bonnes pratiques

  • Utilisez des noms de variables et de fonctions ou des extraits de code pertinents. Cela permet de guider la personnalisation du code vers les exemples de code les plus pertinents.
  • Utilisez les dépôts d'index que vous souhaitez faire évoluer et évitez d'ajouter des fonctionnalités obsolètes. La personnalisation du code permet d'adapter le style, les modèles, la sémantique, les connaissances et les implémentations du code dans l'ensemble du codebase. Les fonctionnalités obsolètes, le code généré et les anciennes implémentations ne constituent pas de bons exemples de dépôts à faire évoluer.
  • Pour les cas d'utilisation de récupération de code, utilisez la fonctionnalité de génération de code au lieu de la complétion de code. Utilisez des prompts tels que "En utilisant la définition de FUNCTION_NAME, génère exactement la même fonction" ou "Génère l'implémentation exacte de FUNCTION_NAME".
  • Incluez ou importez des éléments dans le fichier pour le code que vous souhaitez récupérer afin d'améliorer la compréhension du contexte par Gemini.
  • N'exécutez qu'une seule action par prompt. Par exemple, si vous souhaitez récupérer du code et l'implémenter dans une nouvelle fonction, utilisez deux prompts différents.
  • Pour les cas d'utilisation où vous souhaitez obtenir plus que du code (comme des explications de code, un plan de migration ou explication des erreurs), utilisez la personnalisation du chat basée sur le code. Celle-ci vous permet d'interagir avec Gemini en tenant compte de votre codebase.
  • Notez que la génération de modèles d'IA n'est pas déterministe. Si vous n'êtes pas satisfait de la réponse, vous pouvez exécuter à nouveau le même prompt pour obtenir un meilleur résultat.
  • Notez que la génération de tests unitaires fonctionne généralement mieux si vous ouvrez le fichier localement, puis demandez au chat de générer des tests unitaires pour ce fichier ou une fonction spécifique.

Obtenir des suggestions plus pertinentes avec le contexte du dépôt distant

Vous pouvez obtenir des suggestions de code plus pertinentes et adaptées au contexte en demandant à Gemini Code Assist de se concentrer sur des dépôts distants spécifiques. En utilisant le symbole @ dans le chat, vous pouvez sélectionner un ou plusieurs dépôts à utiliser comme source principale de contexte pour vos requêtes. Cela est utile lorsque vous travaillez sur une tâche qui est principalement liée à un ensemble spécifique de microservices, de bibliothèques ou de modules.

Pour utiliser un dépôt distant comme contexte, procédez comme suit dans le chat de votre IDE :

  1. Commencez votre requête par le symbole @. Une liste des dépôts distants indexés disponibles s'affiche.
  2. Dans la liste, sélectionnez le dépôt que vous souhaitez utiliser pour le contexte. Vous pouvez également commencer à saisir le nom du dépôt pour filtrer la liste.
  3. Après avoir sélectionné le dépôt, rédigez le reste de votre requête.

Gemini donnera ensuite la priorité au dépôt sélectionné lors de la génération d'une réponse.

Exemples de requêtes

Voici quelques exemples d'utilisation de cette fonctionnalité :

  • Pour comprendre un dépôt :
    • "@REPOSITORY_NAME Quelle est la structure globale de ce dépôt ?"
    • @REPOSITORY_NAME Je suis un nouveau membre de l'équipe. Peux-tu me donner un aperçu de l'objectif de ce dépôt et de ses modules clés ?"
  • Pour la génération et la modification de code :
    • "@REPOSITORY_NAME Implémente une fonction d'authentification semblable à celle de ce dépôt."
    • "@REPOSITORY_NAME Refactorise le code suivant pour qu'il respecte les conventions du dépôt sélectionné."
    • "@REPOSITORY_A_NAME Comment puis-je utiliser les dernières fonctions de ce dépôt pour améliorer mon code dans REPOSITORY_B_NAME ?"
  • Pour les tests :
    • "@UNIT_TEST_FILE_NAME Génère des tests unitaires pour MODULE en fonction des exemples du fichier sélectionné."

En utilisant des dépôts distants comme source de contexte ciblée, vous pouvez obtenir des suggestions plus précises et pertinentes de Gemini Code Assist, ce qui peut vous aider à coder plus rapidement et plus efficacement.