Sprachunterstützung und Standards

In der folgenden Tabelle sind die Code-Sprachen und der entsprechende Dokumentationsstandard für jede Code-Sprache aufgeführt.

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.

Verwendung eines Chat-Befehls zur Erstellung von Dokumentation

Sie können den Befehl ' /document im Chat verwenden, um Dokumentation für eine referenzierte Datei oder eine Methode oder eine Klasse im aktiven Arbeitsbereich zu erzeugen.

Verwenden Sie die folgende Syntax:

/document <code reference> [additional instructions]

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

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

• 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 des CodeLens im Editor zur Erstellung von Dokumentation

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

1. Klicken Sie auf die Option Dokument, die unmittelbar vor einem Codeblock oder Snippet steht, um dessen Dokumentation zu erstellen.

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

   

2. Das Chat-Fenster watsonx Code Assistant öffnet sich, zeigt den Befehl " /document @<*item name*> an, führt den Befehl aus und zeigt den Code mit der Dokumentation als Kommentar an.