Development V
Conventies
Wat zijn conventies?
- Een aantal afspraken/richtlijnen die een programmeerstijl bepalen. Deze bevatten
procedures en formateringen van een programmeertaal.
Waardoor bestaan conventies?
- Nood om complexiteit te vermijden en debugging makkelijker te maken.
Doel van conventies?
- Zorgt voor uniforme uitstaling van code
- Verminderd complexiteit, projecten makkelijker onderhouden
- Makkelijker herbruiken van code, makkelijker deduggen
- Hogere efficiëntie van de programmeurs
Nadelen van conventies?
- Inconsistent gebruik van conventie binnen een bedrijf
- Hogere drempel bij start van gebruik
Voordelen van conventies?
- Frustratie voorkomen
- Structuur herkennen in projecten
- Zelfzeker programmeren
Voorbeelden van conventies?
- Vastgelegde mappenstructuur
- Hoofdletters benaming globale variabelen
- Altijd omschrijving bij functies
Soorten conventies
- Naamgeving
- Formaterig
- Rond bestanden
- Git conventies
- Documentaties
- Testing
Vaak voorkomende conventies
- JS airbnb: Airbnb heeft een set gepubliceerde regels rondom formatering, zeer accurate en
volledige beschrijving.
- BEM syntax: Block Element Modifier, gebruik in context van CSS
- GIT angular commit message conventions: verdere uitbreiding op de gewonelijke GIT
conventies
, Naamgeving conventies
- Wordt weinig afgedwongen
- Consistentie binnen projecten zeker nodig, liefst ook binnen hetzelfde bedrijf
Voorbeelden
- Klassen beginnen met een hoofdletter
- camelCase is de standaard
- Componentbestanden beginnen met een hoofdletter
- Globale variabelen in all caps
Formattering conventies
- Plaatsing van enters en backspaces
- Tabs vs. Spaces discussie
Conventies rond bestanden
- Splitsing volgens specialisatie
- ‘Shared folder’ waarin gedeelde componenten leven (bv: errorMessage)
Documentatie conventies
- Documenteren waar nodig, geen overbodige documentatie
- Documenteren per functie
- README.md bestand met uitleg over het project
Belangrijk: documentatie dat niet meer accuraat is verwijderen
Testing conventies
Afspraken rondom hoe de testen worden opgesteld
- Wanneer er wordt getest
- Hoe diepgaand de tests zijn
- Waarvoor we tests gebruiken
- Hoe en waar testen gedefinieerd
Conventies
Wat zijn conventies?
- Een aantal afspraken/richtlijnen die een programmeerstijl bepalen. Deze bevatten
procedures en formateringen van een programmeertaal.
Waardoor bestaan conventies?
- Nood om complexiteit te vermijden en debugging makkelijker te maken.
Doel van conventies?
- Zorgt voor uniforme uitstaling van code
- Verminderd complexiteit, projecten makkelijker onderhouden
- Makkelijker herbruiken van code, makkelijker deduggen
- Hogere efficiëntie van de programmeurs
Nadelen van conventies?
- Inconsistent gebruik van conventie binnen een bedrijf
- Hogere drempel bij start van gebruik
Voordelen van conventies?
- Frustratie voorkomen
- Structuur herkennen in projecten
- Zelfzeker programmeren
Voorbeelden van conventies?
- Vastgelegde mappenstructuur
- Hoofdletters benaming globale variabelen
- Altijd omschrijving bij functies
Soorten conventies
- Naamgeving
- Formaterig
- Rond bestanden
- Git conventies
- Documentaties
- Testing
Vaak voorkomende conventies
- JS airbnb: Airbnb heeft een set gepubliceerde regels rondom formatering, zeer accurate en
volledige beschrijving.
- BEM syntax: Block Element Modifier, gebruik in context van CSS
- GIT angular commit message conventions: verdere uitbreiding op de gewonelijke GIT
conventies
, Naamgeving conventies
- Wordt weinig afgedwongen
- Consistentie binnen projecten zeker nodig, liefst ook binnen hetzelfde bedrijf
Voorbeelden
- Klassen beginnen met een hoofdletter
- camelCase is de standaard
- Componentbestanden beginnen met een hoofdletter
- Globale variabelen in all caps
Formattering conventies
- Plaatsing van enters en backspaces
- Tabs vs. Spaces discussie
Conventies rond bestanden
- Splitsing volgens specialisatie
- ‘Shared folder’ waarin gedeelde componenten leven (bv: errorMessage)
Documentatie conventies
- Documenteren waar nodig, geen overbodige documentatie
- Documenteren per functie
- README.md bestand met uitleg over het project
Belangrijk: documentatie dat niet meer accuraat is verwijderen
Testing conventies
Afspraken rondom hoe de testen worden opgesteld
- Wanneer er wordt getest
- Hoe diepgaand de tests zijn
- Waarvoor we tests gebruiken
- Hoe en waar testen gedefinieerd
