Spiegazione del codice

watsonx Code Assistant

Utilizzare l'intelligenza artificiale generativa per analizzare e riassumere il codice e capire cosa fa il codice.

La tabella seguente elenca il tipo di spiegazione per ogni piano.

Tipi di spiegazione
Piano Spiegazione Descrizione
Piano di prova Piano essenziale Base Utilizza l'intelligenza artificiale generativa per fornire una spiegazione di base. Non è necessaria un'ulteriore analisi del codice.
Piano Standard Avanzato Richiede un'applicazione costruita e utilizza un'analisi del codice e un'intelligenza artificiale generativa per fornire una spiegazione avanzata del codice per metodi/classi Java e applicazioni Java aziendali.

Solo per l' Eclipse IDE: Per ottenere risultati ottimali con un'applicazione Java multimodulo, assicurarsi di importare il modulo aggregatore e ogni sottomodulo come progetti separati nell'area di lavoro di Eclipse. è improbabile che Watsonx Code Assistant riesca a eseguire l'introspezione del progetto se si importa la directory di primo livello come un unico progetto.

Supporto linguistico

La spiegazione del codice è disponibile per le seguenti lingue:

  • C
  • C++
  • Vai
  • Java
  • JavaScript
  • Python
  • TypeScript

Quando si fa riferimento a un metodo o si usa CodeLens su un metodo, watsonx Code Assistant supporta alcuni linguaggi di codice. Il riferimento a un file completo funziona per tutte le lingue. Per ulteriori informazioni, vedere Supporto linguistico quando si lavora con i metodi.

Utilizzare un comando di chat per spiegare il codice

È possibile utilizzare il comando '/explain in chat per spiegare il codice di una classe, di un file, di una funzione o di un metodo di riferimento nell'area di lavoro attiva.

Utilizzare questa sintassi:

/explain <code reference> [additional instructions]

  • Assicuratevi di iniziare il prompt con /explain, seguito dal resto della sintassi.

  • Per '<code reference>, digitare il simbolo '@ per visualizzare un elenco di classi, file, funzioni e metodi dell'area di lavoro. Utilizzate un solo riferimento di classe, file, funzione o metodo alla volta.

  • Il " [additional instructions] è facoltativo. Aggiungete le istruzioni se volete dettagli specifici.

Quando si fa riferimento a un file, il limite di dimensione è di 50 KB. Se si raggiunge questo limite, dividere il file in singole funzioni e fare riferimento a ciascuna funzione. Oppure, dividere il file a 49 KB, tenendo conto dei limiti delle funzioni, e fare riferimento al file a ogni divisione. Con entrambi gli approcci, è necessario unire i risultati.

Utilizzo del CodeLens nell'editor per spiegare il codice

Nell'editor dell'IDE, CodeLens mostra una riga di opzioni di IA generativa che precede i blocchi di codice e gli snippet.

Problema noto Se si utilizza l'estensione watsonx Code Assistant for Enterprise Java Applications, all'avvio potrebbero essere necessari alcuni secondi perché le funzionalità Java avanzate siano disponibili da CodeLens.

  1. Fare clic sull'opzione Spiega che precede immediatamente un blocco di codice per generare una spiegazione.

    Nel seguente esempio di codice, le opzioni " Explain | Document | Unit Test precedono immediatamente le parole chiave " protected void.

    Esempio di lente di codice
    Esempio diCodeLens

  2. Si apre la finestra di chat watsonx Code Assistant, si visualizza il comando '/explain @<*item name*>, si esegue il comando e si visualizza la spiegazione.

Disabilitazione CodeLens

Se si desidera disattivare le opzioni di CodeLens, è possibile modificare l'impostazione dell'estensione o del plug-in.

In Visual Studio Code:

  1. Aprire le impostazioni dell'estensione.

  2. Cancellare l'impostazione di Enable CodeLens.

In Eclipse:

  1. Aprire le impostazioni del sito Eclipse IDE.

  2. Nella voce Impostazioni di watsonx Code Assistant, deselezionare l'impostazione Enable CodeLens.

  3. Fare clic su Applica e chiudere.

Utilizzare l'explorer per spiegare il codice

Per generare una spiegazione dall'Explorer ( Visual Studio Code ) o dal Project Explorer ( Eclipse ):

  1. Espandere l'applicazione al codice per il quale si desidera generare una spiegazione.

  2. Fare clic con il tasto destro del mouse sul codice, fare clic su watsonx Code Assistant, quindi su Spiega.

  3. La chat watsonx Code Assistant visualizza il comando '/explain per il codice selezionato. Il comando utilizza la seguente sintassi:

    /explain <code syntax>

  4. Watsonx Code Assistant elabora la richiesta e nella chat visualizza la spiegazione del codice selezionato.

Spiegare le applicazioni Java

Piano standard La spiegazione dell'applicazione è disponibile solo con l'estensione watsonx Code Assistant for Enterprise Java Applications.

La spiegazione dell'applicazione è supportata solo per le applicazioni Java che contengono una o più classi che estendono 'javax.servlet.http.HttpServlet. Queste classi devono implementare uno dei seguenti metodi: 'doGet, 'doPost o 'doPut.

Per le applicazioni di grandi dimensioni, la spiegazione considera i 40 punti di ingresso con la complessità ciclomatica più elevata. Se la domanda supera i 40 punti di ingresso, la spiegazione contiene la sezione The following methods were not considered: che fornisce dettagli su quali punti di ingresso non sono stati considerati.

Per richiedere e visualizzare una spiegazione per una domanda:

  1. Nell'IDE, fate clic con il pulsante destro del mouse su qualsiasi elemento della gerarchia nella directory dell'applicazione che volete spiegare, quindi fate clic su Spiega applicazione.

    Nell' Eclipse IDE, se si ha un'applicazione multimodulo con una radice multimodulo peer, la spiegazione dell'applicazione si applica solo al modulo selezionato.

  2. Watsonx Code Assistant analizza l'applicazione per generare una panoramica e un elenco dei servizi principali con una descrizione delle funzioni per ogni metodo.

  3. Fare clic su Salva per conservarne una copia, altrimenti la spiegazione viene eliminata.

  4. Fare clic su Apri la spiegazione e rivederla, quindi fare clic su Salva la spiegazione dell'applicazione per memorizzarla in un file locale.