Reglas de nombramiento legibles para IA

Este documento aún está en proceso de validación. Esperamos discutirlo activamente en la Issue de GitHub.

Descripción

Este documento describe patrones de reglas de nombramiento que pueden ser útiles al escribir código y utilizar herramientas de asistencia de codificación para IA. Utilizando estos patrones, se puede escribir código que sea más fácil de leer y entender para la IA.

Problema

A menudo surge el problema de cómo nombrar variables y funciones al escribir código. Además, si se intenta proporcionar contexto solo a través de comentarios, el código puede resultar difícil de entender para el lector. Esta dificultad para leer también puede afectar la precisión de GitHub Copilot. Eventualmente, puede que ya no sea posible recibir sugerencias precisas de GitHub Copilot.

Contexto

GitHub Copilot, la herramienta de asistencia de codificación para IA más popular, utiliza un motor llamado Codex, el cual se basa en el modelo GPT-3. El modelo GPT-3 puede entender el lenguaje natural, y Codex también puede entender el lenguaje natural de manera similar. Utilizando expresiones de variables similares al lenguaje natural, se puede escribir código que sea más fácil de leer y entender.

Solución

Cuando se enfrenta al problema de cómo nombrar variables y funciones al escribir código, se puede crear una regla de nomenclatura común previamente establecida en equipo, la cual se asume que la herramienta de asistencia de codificación de IA puede leer para escribir código que sea más fácil de leer y entender para la IA. En lugar de proporcionar contexto solo a través de comentarios, se pueden utilizar expresiones de variables similares al lenguaje natural para que la herramienta de asistencia de codificación de IA pueda hacer sugerencias más precisas.

A continuación, se presentan algunos ejemplos de patrones de reglas de nombramiento:

• Utilizar letras minúsculas / Utilizar camelCase

• Utilizar expresiones de variables similares al lenguaje natural

• Utilizar nombres cortos

• Utilizar nombres descriptivos

Resultado

Al utilizar estos patrones de reglas de nombramiento, se puede escribir código que sea más fácil de leer y entender para la IA, lo cual permite que la herramienta de asistencia de codificación de IA haga sugerencias más precisas.