Esaminare le funzionalità di "spiegazione" e "documento" di GitHub Copilot

  • 5 minuti

GitHub Copilot semplifica l'uso da parte degli sviluppatori di codice complesso o sconosciuto. In Visual Studio Code gli sviluppatori hanno accesso diretto alle funzionalità di GitHub Copilot che analizzano, spiegano o documentano il codice.

Analizzare e spiegare il codice usando GitHub Copilot

Per analizzare e spiegare il codice, è possibile usare le funzionalità di GitHub Copilot seguenti:

  • Modalità Richiesta: usare la visualizzazione Chat in modalità ask per analizzare l'intera area di lavoro e porre domande su argomenti di codifica, concetti tecnologici e procedure di programmazione generali.

  • Chat inline: avviare una sessione di chat inline direttamente dall'editor per chiedere informazioni su sezioni di codice specifiche.

  • Azioni intelligenti: eseguire l'azione Spiega intelligente per spiegare il codice selezionato senza dover scrivere una richiesta.

  • Chat veloce: porre una domanda rapida e tornare a quello che stai facendo.

Generare la documentazione del codice inline usando GitHub Copilot

Per generare la documentazione del codice inline, è possibile usare le funzionalità di GitHub Copilot seguenti:

  • Modalità Richiesta: usare la modalità Ask agent per suggerire la documentazione del codice inline per un file di codice, una classe o un metodo. Esaminare la documentazione inline suggerita nella visualizzazione Chat. Richiedere aggiornamenti in base alle esigenze nella conversazione di chat. Dopo aver soddisfatto la documentazione proposta, è possibile inserire la documentazione suggerita nel file di codice corrispondente.

  • Modalità piano: usare la modalità Piano per creare un piano di implementazione dettagliato per le attività della documentazione. La modalità piano può essere usata per analizzare la codebase, identificare i requisiti della documentazione e produrre un piano dettagliato. Dopo aver approvato il piano, è possibile passare alla modalità Agente per l'esecuzione.

  • Modalità agente: usare la modalità Agente per generare in modo autonomo la documentazione del codice inline per progetti di codice, file, classi o metodi specificati. Chiedere all'agente di eseguire altre attività durante o dopo il processo di documentazione. Accettare o rifiutare gli aggiornamenti quando l'agente ha completato le attività assegnate.

  • Chat inline: usare una sessione di chat inline per funzionare direttamente nell'editor di codice. La chat inline è utile quando vuoi documentare codice specifico (classi, metodi o blocchi di codice) senza uscire dall'editor. È possibile fornire istruzioni specifiche nel prompt o usare il /doc comando slash senza informazioni specifiche, se necessario. Gli aggiornamenti vengono visualizzati nell'editor di codice e possono essere accettati o rifiutati. È anche possibile scegliere l'opzione per eseguire nuovamente il prompt con o senza aggiornamenti.

  • Azione intelligente Genera documentazione: usa l'azione intelligente Genera documentazione per creare documentazione del codice inline per una classe, un metodo o un blocco di codice selezionato. L'azione intelligente Genera documenti è utile quando non si hanno requisiti specifici che richiedono una richiesta. Gli aggiornamenti vengono visualizzati nell'editor di codice e possono essere accettati o rifiutati. È possibile anche rieseguire l'azione intelligente.

Generare la documentazione del progetto usando GitHub Copilot

Per generare la documentazione del progetto, è possibile usare le funzionalità di GitHub Copilot seguenti:

  • Visualizzazione chat in modalità agente Ask: usare l'agente Ask per analizzare la codebase e comprendere i progetti di codice, i file e le classi. L'agente Ask può essere usato per visualizzare in anteprima la documentazione del progetto suggerita. Esaminare i suggerimenti e richiedere aggiornamenti o altri dettagli in base alle esigenze. Inserire la documentazione suggerita in un file di documentazione del progetto (README.md).

  • Visualizzazione chat in modalità agente pianificazione: creare un piano di implementazione dettagliato per la documentazione del progetto, quindi affidare alla modalità agente per l'esecuzione.

  • Visualizzazione chat in modalità agente: generare una raccolta di file di documentazione del progetto: creare/aggiornare il README.md, creare/aggiornare il UsageExamples.md e creare/aggiornare il ChangeLog.md. Includere collegamenti tra i file della documentazione, creare riferimenti incrociati tra le classi e i metodi, e garantire la coerenza nei documenti.

Importante

Quando si usa la visualizzazione chat in modalità agente, ogni richiesta viene considerata come richiesta premium, moltiplicata per il moltiplicatore del modello. GitHub Copilot potrebbe eseguire diverse azioni di completamento dell'attività, ma queste azioni di completamento non vengono conteggiate per l'utilizzo delle richieste premium. Vengono fatturati solo i prompt immessi. Le richieste Premium totali usate dipendono dal numero di richieste immesse e dal modello selezionato. Il piano gratuito per GitHub Copilot ottiene 50 richieste premium al mese. Controllare le descrizioni dei piani per altri dettagli sui limiti delle richieste Premium per ogni sottoscrizione GitHub Copilot.

Riassunto

GitHub Copilot consente di analizzare e documentare il codice in modo rapido e accurato. Le funzionalità di chat, chat inline, chat rapida e azione intelligente offrono vari livelli di interazione direttamente all'interno dell'ambiente Visual Studio Code.