Houd variabele- en identifiernamen kort en consistent

Probleem

Naamgevingsconventies helpen om code en repositories leesbaar te houden, maar te lange of inconsistente namen zorgen voor ruis. Gemengde stijlen zoals myVariable, my_variable en my-variable maken projecten ook moeilijker scanbaar.

Context

In softwareontwikkeling geven we voortdurend namen aan bestanden, projecten, branches, variabelen en andere identifiers. Een eenvoudig standaardpatroon houdt naamgeving voorspelbaar en verlaagt de frictie.

Oplossing

Geef de voorkeur aan korte namen die duidelijk blijven. Gebruik kleine letters met - als standaard scheidingsteken. Vermijd hoofdletters, _ en camelCase tenzij een taal, tool of upstream-conventie een ander formaat vereist.

Deze benadering heeft de volgende voordelen:

1. Namen zijn gemakkelijk te lezen en te onthouden.
2. Minder typen en minder complex typen verkleinen de kans op fouten.
3. De standaard is makkelijk te onthouden: kies bij twijfel de kortste duidelijke naam.

Voorbeelden en implementatie

Voorbeelden van namen die deze conventie volgen:

1. index.html
2. style.css
3. main.js

Projectnamen:

1. mijn-project
2. web-app
3. e-commerce

Branchnamen:

1. feature/add-new-feature
2. fix/bug-123
3. hotfix/security-issue

Gebruik alleen een ander formaat wanneer de omliggende tool of programmeertaal dat verwacht, bijvoorbeeld wanneer omgevingsvariabelen hoofdletters vereisen of een taal snake_case of camelCase gebruikt voor identifiers.