Code Standard

Attention

Dit document is een schets en zeer incompleet, en misschien wel fout.

Een van de belangrijkste aspected van goede bron code is het de leestbaarheid van de code. Om het even extreen te zeggen, Goede code heeft geen documentatie nodig. echter is goede code zeer moeilijk om te maken dus moet er goed gedocumenteerd worden.

Toch moet men, om de code aan te passen, zich in de code zelf verdiepen. Hierbij helpt het als deze goed geformarteerd is. Hieronder een lijst (met voorgestelde) afspraken om de code goed leesbaar te houden en maken.

• Geef variable begrijpelijke namen die een omschrijving geven van hun type data.
• Gebruikt de juist indentatie, al is dat verplicht voor Pythen dus niet zo probleem in dit project. Wel gebruik 4 spaties per indentatie en NOOIT tab sympolen (check je editor)
• Kluster het aanmaken van variable zo ver mogelijk bovenin de functie en/of class. Sorteer hierin ook in vergelijkbare type. (int, float, etc)
• Zet ‘=’ tekens zo ver mogelijk op 1 lijn door gebruik van spaties. Dit is vriendelijk voor de oog en veel beter leesbaar. (en we schrijven niet meer in fortran67 met een regellengthe limit ;))

Comment stijl; hierin zijn er een paar richtlijnen. Terug grijpen op “goede code heeft geen documentatie nodig”, denk als je een comment wilt toevoegen, “kan ik de code anders maken dat er geen comment nodig is?”.

• Zo ja, doe dit en je code is (zeer waarschijnlijk) veel beter.
• Zo nee, zet je comment neer waarin je verteld niet alleen wat er gebeurt maar ook waarom. Vooral dit laatste is erg handig voor je opvolgers.