Regras de Nomenclatura Legíveis por IA

Este documento ainda está em verificação. Espera-se uma discussão ativa no issue do GitHub.

Descrição

Este documento descreve padrões de nomenclatura que podem ser úteis ao escrever códigos com ferramentas de assistência à codificação de AI. Usar esses padrões pode ajudar a criar códigos mais legíveis e fáceis de entender para a AI.

Problema

Ao escrever código, pode ser difícil decidir como nomear variáveis e funções. Além disso, confiar apenas em comentários para fornecer contexto pode resultar em códigos difíceis de entender para o leitor. Essa dificuldade de leitura também pode afetar a precisão do GitHub Copilot. Eventualmente, o GitHub Copilot não será capaz de fornecer sugestões precisas.

Contexto

O GitHub Copilot, a principal ferramenta de assistência à codificação de AI, usa um mecanismo chamado Codex, que é baseado no modelo GPT3. O modelo GPT3 pode entender a linguagem natural, e o Codex também pode entender a linguagem natural. Usando expressões de variáveis que se assemelham à linguagem natural, é possível escrever códigos mais legíveis e fáceis de entender.

Solução

Ao escrever códigos, se você estiver tendo dificuldades para nomear variáveis e funções, é possível criar uma nomenclatura comum pré-definida em equipe, pressupondo que a ferramenta de assistência à codificação de AI possa ler essa nomenclatura, para escrever códigos mais legíveis e fáceis de entender para a AI. Em vez de depender apenas de comentários para fornecer contexto, é possível usar expressões de variáveis que se assemelham à linguagem natural, permitindo que a ferramenta de assistência à codificação de AI ofereça sugestões mais precisas.

A seguir estão exemplos de padrões de nomenclatura:

• Use letras minúsculas / use CamelCase.

• Use expressões de variáveis que se assemelham à linguagem natural.

• Use nomes curtos.

• Use nomes descritivos.

Contexto resultante

Usando esses padrões de nomenclatura, é possível escrever códigos mais legíveis e fáceis de entender para a AI e também permitir que a AI ofereça sugestões mais precisas de código.