Code layout

Naam en doel

De naam van de auteur en het doel van het programma staan boven de hoofdklasse van het programma.

Layout

De layout van de code is zodanig dat de structuur zowel bij afdruk als op scherm goed te zien is. De VSCode standaard “format” optie volstaat:

• Indentatie 4 spaties
• Sluitaccolade } op dezelfde kolom als 1e letter van de regel met open-accolade {

Tip: Autoformat VSCode

In VSCode kan je de code automatisch laten formatteren. Dit doe je door de toetsencombinatie Alt+Shift+F (mac: Cmd+Shift+F) in te drukken. Je kan ook de rechtermuisknop gebruiken en dan Format Document kiezen.

Andere IDE’s hebben vaak dezelfde optie. Zoek in de documentatie van je IDE naar “autoformat”.

Lengte van coderegels

Coderegels moeten niet langer dan 120 tekens zijn, liefst korter dan 100

Dode code

Verwijder statements die weg kunnen en maak je programma “schoon”. Dit geldt ook voor code die “commented-out” is. NetBeans herkent ongebruikte importregels en variabelen maar kan niet altijd “zien” of een stuk code helemaal weg kan. Zorg ervoor dat je programma leesbaar en begrijpelijk is voor beginners.

Scoping

Variabelen worden (alleen) gedeclareerd op de plek waar ze gebruikt worden.

• Klasse-attributen mogen niet worden gebruikt als vervanging van methode parameters of lokale variabelen van een methode.
• Static attributen mogen niet worden misbruikt als globale variabelen of als vervanging van een associatie tussen twee klassen.
• Attributen van een klasse zijn private. Uitzonderingen toelichten.