Regole di denominazione AI-Readable

Questo documento è ancora in fase di verifica. Ci aspettiamo una discussione attiva su GitHub Issue.

Descrizione

Questo documento descrive i modelli di regole di denominazione che possono aiutare a scrivere codice utilizzando strumenti di assistenza alla codifica basati sull'AI. L'utilizzo di questi modelli può consentire di scrivere codice più leggibile e comprensibile dall'AI.

Problema

Spesso quando si scrive codice, ci si chiede come nominare le variabili e le funzioni. Inoltre, se si cerca di fornire contesto solo tramite i commenti, si può finire con scrivere codice di difficile comprensione per chi lo legge. Questa scarsa leggibilità può influire anche sulla precisione di GitHub Copilot, impedendo di ricevere proposte accurate.

Contesto

GitHub Copilot, uno dei principali strumenti di assistenza alla codifica basati sull'AI, utilizza un motore chiamato Codex, basato sul modello GPT-3. Il modello GPT-3 può comprendere il linguaggio naturale, e Codex può fare lo stesso. Utilizzando espressioni di variabili simili al linguaggio naturale, è possibile scrivere codice più leggibile e comprensibile.

Soluzione

Se si ha difficoltà a nominare le variabili o le funzioni durante la scrittura del codice, si può creare una regola di denominazione condivisa in precedenza dal team, assumendo che gli strumenti di assistenza alla codifica basati sull'AI potranno leggerla. In questo modo si può scrivere codice più leggibile e comprensibile dall'AI, senza dover fornire contesto solo tramite i commenti, ma utilizzando espressioni di variabili simili al linguaggio naturale. In questo modo, gli strumenti di assistenza alla codifica basati sull'AI possono fornire proposte più precise.

Di seguito sono riportati alcuni esempi di modelli di regole di denominazione:

• Utilizzo di caratteri minuscoli / Utilizzo di CamelCase

• Utilizzo di espressioni di variabili simili al linguaggio naturale

• Utilizzo di nomi brevi

• Utilizzo di nomi descrittivi

Contesto risultante

L'utilizzo di questi modelli di regole di denominazione può consentire di scrivere codice più leggibile e comprensibile dall'AI, e migliorare la precisione delle proposte degli strumenti di assistenza alla codifica basati sull'AI.