Code erläutern

watsonx Code Assistant

Verwenden Sie generative KI, um Ihren Code zu analysieren und zusammenzufassen, um zu verstehen, was der Code tut.

In der folgenden Tabelle ist die Art der Erklärung für jeden Plan aufgeführt.

Erläuterungstypen
Planen Erläuterung Beschreibung
Probeplan Grundlegender Plan Grundlegend Verwendet generative KI, um eine grundlegende Erklärung zu liefern. Eine zusätzliche Code-Analyse ist nicht erforderlich.
Standard-Plan Höhere Erfordert eine erstellte Anwendung und verwendet eine Code-Analyse und generative KI, um eine erweiterte Code-Erklärung für Java und Java zu liefern.

Nur Eclipse IDE: Um mit Java mit mehreren Modulen optimale Ergebnisse zu erzielen, stellen Sie sicher, dass Sie das Aggregatormodul und jedes Untermodul als separate Projekte in Eclipse importieren. Watsonx Code Assistant kann Ihr Projekt wahrscheinlich nicht erfolgreich untersuchen, wenn Sie das Verzeichnis der obersten Ebene als einzelnes Projekt importieren.

Sprachunterstützung

Code-Erklärungen sind für die folgenden Sprachen verfügbar:

  • C
  • C++
  • Los
  • Java
  • JavaScript
  • Python
  • TypeScript

Wenn Sie eine Methode referenzieren oder CodeLens für eine Methode verwenden, unterstützt watsonx Code Assistant bestimmte Code-Sprachen. Der Verweis auf eine vollständige Datei funktioniert in allen Sprachen. Weitere Informationen finden Sie unter Sprachunterstützung bei der Arbeit mit Methoden.

Einen Chat-Befehl verwenden, um Code zu erklären

Sie können den Befehl ' /explain im Chat verwenden, um den Code für eine referenzierte Klasse, Datei, Funktion oder Methode im aktiven Arbeitsbereich zu erklären.

Verwenden Sie die folgende Syntax:

/explain <code reference> [additional instructions]

  • Achten Sie darauf, dass Sie die Eingabeaufforderung mit /explain beginnen, gefolgt vom Rest der Syntax.

  • Geben Sie für " <code reference> das Symbol " @ ein, um eine Liste der Klassen, Dateien, Funktionen und Methoden aus Ihrem Arbeitsbereich anzuzeigen. Verwenden Sie jeweils nur einen Klassen-, Datei-, Funktions- oder Methodenverweis.

  • Die " [additional instructions] sind fakultativ. Fügen Sie Anweisungen hinzu, wenn Sie spezifische Details wünschen.

Wenn Sie eine Datei referenzieren, ist die Größe auf 50 KB begrenzt. Wenn Sie diese Grenze erreichen, teilen Sie die Datei in einzelne Funktionen auf und verweisen auf jede Funktion. Oder Sie teilen die Datei bei 49 KB auf, wobei Sie auf die Funktionsgrenzen achten, und verweisen bei jeder Teilung auf die Datei. Bei beiden Ansätzen müssen Sie die Ergebnisse zusammenführen.

Verwendung der CodeLens im Editor zur Erklärung von Code

Im IDE-Editor zeigt die CodeLens eine Zeile mit generativen KI-Optionen an, die Codeblöcken und Snippets vorangestellt ist.

Bekanntes Problem Wenn Sie die Erweiterung watsonx Code Assistant for Enterprise Java Applications verwenden, kann es beim Starten einige Sekunden dauern, bis die erweiterten Java von CodeLens verfügbar sind.

  1. Klicken Sie auf die Option Erklären, die unmittelbar vor einem Codeblock steht, um eine Erklärung zu erstellen.

    Im folgenden Codebeispiel stehen die Optionen " Explain | Document | Unit Test unmittelbar vor den Schlüsselwörtern " protected void.

    CodeLens Beispiel
    CodeLens Beispiel

  2. Das Chat-Fenster watsonx Code Assistant öffnet sich, zeigt den Befehl " /explain @<*item name*> an, führt den Befehl aus und zeigt die Erklärung an.

Deaktivieren von CodeLens

Wenn Sie die Optionen von CodeLens deaktivieren möchten, können Sie die Einstellung für die Erweiterung oder das Plug-in ändern.

Unter Visual Studio Code:

  1. Öffnen Sie die Einstellungen für die Erweiterung.

  2. Löschen Sie die Einstellung Enable CodeLens.

Unter Eclipse:

  1. Öffnen Sie die Einstellungen für die Eclipse IDE.

  2. Löschen Sie im Eintrag watsonx Code Assistant Einstellungen die Einstellung Enable CodeLens.

  3. Klicken Sie auf Anwenden und schließen Sie.

Den Explorer zur Erklärung von Code verwenden

Um eine Erklärung aus dem Explorer ( Visual Studio Code ) oder Projekt-Explorer ( Eclipse ) zu erstellen:

  1. Erweitern Sie Ihre Anwendung um den Code, für den Sie eine Erklärung erstellen möchten.

  2. Klicken Sie mit der rechten Maustaste auf den Code, klicken Sie auf watsonx Code Assistant und dann auf Erläutern.

  3. Der Chat watsonx Code Assistant zeigt den Befehl " /explain für den von Ihnen gewählten Code an. Der Befehl hat die folgende Syntax:

    /explain <code syntax>

  4. Watsonx Code Assistant bearbeitet die Anfrage und zeigt im Chat die Erklärung für den von Ihnen gewählten Code an.

Erklärungen zu Java

Standardplan Anwendungserklärung ist nur mit der Erweiterung watsonx Code Assistant for Enterprise Java Applications verfügbar.

Die Anwendungserklärung wird nur für Java unterstützt, die eine oder mehrere Klassen enthalten, die " javax.servlet.http.HttpServlet erweitern. Diese Klassen müssen eine der folgenden Methoden implementieren: " doGet, " doPost, oder " doPut.

Bei großen Anwendungen berücksichtigt die Erklärung die 40 Einstiegspunkte mit der höchsten zyklomatischen Komplexität. Wenn der Antrag mehr als 40 Eintragspunkte umfasst, enthält die Erläuterung den Abschnitt The following methods were not considered:, der Aufschluss darüber gibt, welche Eintragspunkte nicht berücksichtigt wurden.

Um eine Erklärung für eine Bewerbung anzufordern und einzusehen:

  1. Klicken Sie in Ihrer IDE mit der rechten Maustaste auf ein beliebiges Element in der Hierarchie im Verzeichnis der Anwendung, die Sie erklären möchten, und klicken Sie dann auf Anwendung erklären.

    Wenn Sie in der Eclipse IDE eine Multimodul-Anwendung mit einem Peer-Multimodul-Root haben, gilt die Anwendungserklärung nur für das ausgewählte Modul.

  2. Watsonx Code Assistant scannt die Anwendung, um eine Übersicht und eine Liste der wichtigsten Dienste mit einer Beschreibung der Funktionen für jede Methode zu erstellen.

  3. Klicken Sie auf Speichern, um eine Kopie zu behalten, oder die Erklärung wird verworfen.

  4. Klicken Sie auf Erklärung öffnen und überprüfen, und klicken Sie dann auf Anwendungserklärung speichern, um sie in einer lokalen Datei zu speichern.