Explication du code

watsonx Code Assistant

Utilisez l'IA générative pour analyser et résumer votre code afin de comprendre ce qu'il fait.

Le tableau suivant présente le type d'explication pour chaque régime.

Types d'explications
Plan Explication Description
Plan d'essai Plan essentiel Basic Utilise l'IA générative pour fournir une explication de base. Aucune analyse de code supplémentaire n'est nécessaire.
Forfait standard Amélioré Nécessite une application construite, et utilise une analyse de code et une IA générative pour fournir une explication de code améliorée pour les méthodes/classes Java et les applications Java d'entreprise.

Eclipse IDE uniquement: Pour obtenir les meilleurs résultats avec une application Java multimodule, veillez à importer le module agrégateur et chaque sous-module en tant que projets distincts dans l'espace de travail Eclipse. il est peu probable que Watsonx Code Assistant réussisse à inspecter votre projet si vous importez le répertoire de premier niveau en tant que projet unique.

Support linguistique

L'explication du code est disponible pour les langues suivantes :

  • C
  • C++
  • Go
  • Java
  • JavaScript
  • Python
  • TypeScript

Lorsque vous faites référence à une méthode ou que vous utilisez CodeLens sur une méthode, watsonx Code Assistant prend en charge certains langages de code. La référence à un fichier complet fonctionne pour toutes les langues. Pour plus d'informations, voir Assistance linguistique lorsque vous travaillez avec des méthodes.

Utiliser une commande de chat pour expliquer le code

Vous pouvez utiliser la commande " /explain dans le chat pour expliquer le code d'une classe, d'un fichier, d'une fonction ou d'une méthode référencée dans l'espace de travail actif.

Utilisez la commande suivante :

/explain <code reference> [additional instructions]

  • Veillez à commencer l'invite par /explain, suivi du reste de la syntaxe.

  • Pour " <code reference>, tapez le symbole " @ pour obtenir une liste de classes, de fichiers, de fonctions et de méthodes de votre espace de travail. Utilisez une référence de classe, de fichier, de fonction ou de méthode à la fois.

  • Le " [additional instructions] est facultatif. Ajoutez des instructions si vous souhaitez des détails spécifiques.

Lorsque vous faites référence à un fichier, la taille maximale est de 50 KB. Si vous atteignez cette limite, divisez le fichier en fonctions individuelles et faites référence à chaque fonction. Vous pouvez également diviser le fichier en 49 Ko, en tenant compte des limites des fonctions, et faire référence au fichier à chaque division. Quelle que soit l'approche retenue, il faut fusionner les résultats.

Utiliser la CodeLens dans l'éditeur pour expliquer le code

Dans l'éditeur IDE, CodeLens affiche une ligne d'options d'IA générative qui précède les blocs de code et les extraits.

Problème connu Si vous utilisez l'extension watsonx Code Assistant for Enterprise Java Applications, au démarrage, il peut s'écouler quelques secondes avant que les fonctionnalités Java améliorées ne soient disponibles dans CodeLens.

  1. Cliquez sur l'option Expliquer qui précède immédiatement un bloc de code pour générer une explication.

    Dans l'exemple de code suivant, les options " Explain | Document | Unit Test précèdent immédiatement les mots-clés " protected void.

    Exemple de lentille de codage
    Exemple deCodeLens

  2. La fenêtre de discussion watsonx Code Assistant s'ouvre, affiche la commande '/explain @<*item name*>, exécute la commande et affiche l'explication.

Désactivation CodeLens

Si vous souhaitez désactiver les options de CodeLens, vous pouvez modifier les paramètres de l'extension ou du plug-in.

Sur Visual Studio Code:

  1. Ouvrez les paramètres de l'extension.

  2. Effacez le paramètre Enable CodeLens.

Sur Eclipse:

  1. Ouvrez les paramètres du site Eclipse IDE.

  2. Dans l'entrée watsonx Code Assistant Settings, effacez le paramètre Enable CodeLens.

  3. Cliquez sur Appliquer et fermez.

Utiliser l'explorateur pour expliquer le code

Pour générer une explication à partir de l'explorateur ( Visual Studio Code ) ou de l'explorateur de projet ( Eclipse ):

  1. Étendez votre application au code pour lequel vous souhaitez générer une explication.

  2. Cliquez avec le bouton droit de la souris sur le code, cliquez sur watsonx Code Assistant, puis sur Expliquer.

  3. Le chat watsonx Code Assistant affiche la commande '/explain pour le code que vous avez sélectionné. La syntaxe suivante est utilisée dans la commande :

    /explain <code syntax>

  4. Watsonx Code Assistant traite la demande et affiche dans le chat l'explication du code que vous avez sélectionné.

Explication des applications Java

Plan standard L'explication de la demande n'est disponible qu'avec l'extension watsonx Code Assistant for Enterprise Java Applications

L'explication de l'application n'est prise en charge que pour les applications Java qui contiennent une ou plusieurs classes qui étendent " javax.servlet.http.HttpServlet. Ces classes doivent mettre en œuvre l'une des méthodes suivantes : " doGet, " doPost ou " doPut.

Pour les applications de grande envergure, l'explication prend en compte les 40 points d'entrée présentant la complexité cyclomatique la plus élevée. Si la demande dépasse 40 points d'entrée, l'explication contient la section The following methods were not considered: qui fournit des détails sur les points d'entrée qui n'ont pas été pris en compte.

Pour demander et consulter une explication concernant une demande :

  1. Dans votre IDE, cliquez avec le bouton droit de la souris sur n'importe quel élément de la hiérarchie dans le répertoire de l'application que vous voulez expliquer, puis cliquez sur Expliquer l'application.

    Dans l' Eclipse IDE, si vous avez une application multimodule avec une racine multimodule homologue, l'explication de l'application ne s'applique qu'au module sélectionné.

  2. Watsonx Code Assistant analyse l'application pour générer une vue d'ensemble et une liste des principaux services avec une description des fonctions pour chaque méthode.

  3. Cliquez sur Enregistrer pour conserver une copie, sinon l'explication est rejetée.

  4. Cliquez sur Ouvrir l'explication et réviser, puis vous pouvez cliquer sur Enregistrer l'explication de l'application pour la stocker dans un fichier local.