Het belang van coding standards

Elke onderneming die met developers werkt zou ze moeten hanteren: coding standards. Of noem ze coding conventions. Het punt is dat je er een pak tijd mee bespaart en elke developer snel kan inpikken waar een ander gestopt is. Wat is het, wat doet het en waarom moet het?

if ($codingStandards == FOLLOWED) {
    return 'You are doing good';
}

Coding standards of coding conventions zijn een set regels en voorschriften die developers en software programmeurs volgen om eenheid te krijgen in wat ze schrijven. In plaats van elk in een eigen stijl en vorm te coderen, volgen ze de standaard die vooropgesteld wordt. Op die manier zijn grote projecten, waar meerdere programmeurs aan werken, gestructureerd en netjes. Elke nieuwe programmeur die de code te zien krijgt, weet bij het begin hoe de rest van de code er zal uitzien en kan er veel vlotter doorgaan.

Je kan coding standards vergelijken met het schrijven van een taal. Een spatie na de komma, hoofdletters aan het begin van de zin. Dit zijn zaken die het lezen vlotter maken. Stel je voor dat iedereen een eigen stijl zou toepassen. Een tekst lezen zou plots een vrij zware opdracht worden. Dat is niet anders met code.

Welke standards zijn de beste?

Iemand die de inhoud van coding standards vastlegt, zegt daarom niet dat de ene beter zijn dan de andere. Er is geen objectieve reden om te zeggen dat bijvoorbeeld lijnen code met 70 karakters „beter” zijn dan die met 80 tekens.

Belemmert het de vrijheid van een developer? Misschien voor een deel in het begin omdat hij de conventions nog moet gewoon worden. Eenmaal de routine erin zit, zou dit geen probleem meer mogen zijn. De programmeur geeft een deel van zijn eigen stijl op om in groep op een veel duidelijkere en aangenamere manier te werken.

Ook wij werken met coding standards

De developers bij Wijs passen vooral PSR-2 toe, aangezien dit de coding standard is sinds versie 3.7 van ons favoriete CMS, Fork. Een voorbeeld: de codelijnen worden zoveel mogelijk beperkt tot 80 karakters. Hierdoor kan je twee vensters naast elkaar zetten zonder horizontaal te moeten scrollen. Een kleine maatregel, maar met veel extra efficiëntie als gevolg.

Developers die hier nog niet veel mee gewerkt hebben, kunnen zich in het begin misschien wat frustreren over de vele regeltjes. Voor hen zijn er gelukkig ook al oplossingen. Zo kunnen ze gebruik maken van tools zoals Codesniffer. Deze tool scant de code op coding standards en lost kleine probleempjes zelf op. Het duidt ook aan waar het nog iets beter kan. Instellingen in Sublime Text (of PHP Storm) zoals trim_trailing_white_space_on_save kunnen de developers ook verder op weg helpen. Een .editorconfig kan dit zelfs al per project in je editor correct instellen.

Recap: waarom coding standards binnen je bedrijf?

• Code integration: programmeurs die verschillende stukken code uitwerken en die achteraf moeten geïntegreerd krijgen zijn coding standards dankbaar. Het maakt samenwerken een pak aangenamer.
• Onderhoud: bug in de code? Dankzij coding standards kan je die veel makkelijker opsporen. Stel dat je als developer door de chaotische code van een ander moet graven, dan is bugs opsporen bijzonder moeilijk, aangezien zo’n foutje al gewoon een vergeten punt-komma kan zijn.
• Bespaart tijd: op verschillende niveaus, zoals bij het integreren en het aanpassen van bepaalde scripts of modules.
• Bespaart geld: Het volgen van coding standards kan op termijn een besparing opleveren door minder inwerktijd, gemakkelijker code scannen, herbruikbare code ...