KI-lesbare Benennungsregeln

Dieses Dokument befindet sich noch in der Validierungsphase. Wir erwarten eine aktive Diskussion in den GitHub-Issues.

Beschreibung

Dieses Dokument beschreibt Muster für Benennungskonventionen, die beim Schreiben von Code und der Verwendung von KI-Entwicklungs-Tools hilfreich sind. Durch die Verwendung dieser Muster kann Code erstellt werden, der für KI leichter lesbar und verständlicher ist.

Problem

Beim Schreiben von Code kann es schwierig sein, Namen für Variablen und Funktionen zu finden. Wenn man versucht, den Kontext nur durch Kommentare zu vermitteln, kann der Code für den Leser schwer verständlich sein. Diese Schwierigkeit kann sich auch auf die Genauigkeit von GitHub Copilot auswirken. Schließlich kann es schwierig werden, präzise Vorschläge von GitHub Copilot zu erhalten.

Kontext

GitHub Copilot, eines der bekanntesten KI-Entwicklungs-Tools, verwendet den Codex-Engine, der auf dem GPT3-Modell basiert. Das GPT3-Modell ist in der Lage, natürliche Sprache zu verstehen, und der Codex-Engine kann ebenfalls natürliche Sprache verstehen. Durch die Verwendung von Variablen, die der natürlichen Sprache ähneln, kann Code erstellt werden, der für den Leser leichter lesbar und verständlicher ist.

Lösung

Um Code zu schreiben, der für KI leichter lesbar und verständlicher ist, können Benennungskonventionen im Team vorab festgelegt werden, die KI-Entwicklungs-Tools lesen können. Anstatt nur den Kontext durch Kommentare zu vermitteln, können Variablen verwendet werden, die der natürlichen Sprache ähneln, um präzisere Vorschläge von KI-Entwicklungs-Tools zu erhalten.

Im Folgenden sind Beispiele für Muster von Benennungskonventionen aufgeführt:

• Verwendung von Kleinbuchstaben / CamelCase

• Verwendung von Variablen, die der natürlichen Sprache ähneln

• Verwendung von kurzen Namen

• Verwendung von beschreibenden Namen

Ergebnis

Durch die Verwendung dieser Benennungskonventionen können leichter lesbarer und verständlicherer Code erstellt werden, während KI-Entwicklungs-Tools präzisere Code-Vorschläge machen können.