Supporto linguistico e standard

La tabella seguente elenca i linguaggi di codice e lo standard di documentazione corrispondente per ciascun linguaggio di codice.

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.

Utilizzo di un comando di chat per generare documentazione

È possibile utilizzare il comando '/document in chat per generare la documentazione di un file di riferimento, di un metodo o di una classe nell'area di lavoro attiva.

Utilizzare questa sintassi:

/document <code reference> [additional instructions]

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

• Per '<code reference>, digitare il simbolo '@ per visualizzare un elenco di file, classi e metodi dell'area di lavoro. Utilizzate un file, un metodo o un riferimento di classe 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 di CodeLens nell'editor per generare documentazione

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

1. Fare clic sull'opzione Documento che precede immediatamente un blocco di codice o uno snippet per generare la relativa documentazione.

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

   

2. Si apre la finestra di chat watsonx Code Assistant, si visualizza il comando '/document @<*item name*>, si esegue il comando e si visualizza il codice con la documentazione aggiunta come commento.