Règles de nommage lisibles par l'IA

Ce document est en cours de validation. Nous espérons que vous participerez activement à la discussion sur GitHub Issue.

Description

Ce document décrit les règles de nommage qui peuvent aider à écrire du code plus lisible et plus compréhensible pour l'IA, ainsi que les outils d'assistance à la programmation.

Problème

Lorsque vous écrivez du code, il peut être difficile de décider comment nommer les variables et les fonctions. En outre, essayer de fournir du contexte uniquement en commentant peut rendre le code difficile à comprendre pour les lecteurs. Cette difficulté de lecture affecte également la précision de GitHub Copilot. Finalement, cela peut entraîner une incapacité à recevoir des suggestions précises de GitHub Copilot.

Contexte

Le principal outil d'assistance à la programmation IA, GitHub Copilot, utilise un moteur appelé Codex, qui est basé sur le modèle GPT3. Le modèle GPT3 est capable de comprendre le langage naturel, et Codex est également capable de comprendre le langage naturel. En utilisant une expression de variable similaire à la langue naturelle, vous pouvez écrire du code plus lisible et plus facile à comprendre.

Solution

Si vous êtes confronté à des problèmes de nommage de variables et de fonctions lorsque vous écrivez du code, vous pouvez créer des règles de nommage communes à l'équipe, en supposant que l'outil d'assistance à la programmation IA les lira, pour écrire un code plus lisible et plus compréhensible pour l'IA. Au lieu de fournir uniquement du contexte dans les commentaires, en utilisant une expression de variable similaire à la langue naturelle, l'outil d'assistance à la programmation IA sera en mesure de fournir des suggestions plus précises.

Voici quelques exemples de règles de nommage :

• Utiliser des minuscules / utiliser des majuscules intercalées (camelCase)

• Utiliser une expression de variable similaire à la langue naturelle

• Utiliser des noms courts

• Utiliser des noms descriptifs

Contexte résultant

En utilisant ces règles de nommage, vous pouvez écrire un code plus lisible et plus compréhensible pour l'IA, tout en permettant à l'IA de fournir des suggestions plus précises pour le code.