diff --git a/docs/.pages b/docs/.pages index 922d908..507dac0 100644 --- a/docs/.pages +++ b/docs/.pages @@ -22,4 +22,5 @@ nav: - Feedback : documentatie/Feedback - User Interface : "documentatie/User Interface" - Documentatie game : "documentatie/Documentatie game" - - UML : "documentatie/uml" \ No newline at end of file + - UML : "documentatie/uml" + - Kwaliteitsnormen : "documentatie/kwaliteitsnormen" \ No newline at end of file diff --git a/docs/documentatie/kwaliteitsnormen.md b/docs/documentatie/kwaliteitsnormen.md index 17f68b0..f81ab15 100644 --- a/docs/documentatie/kwaliteitsnormen.md +++ b/docs/documentatie/kwaliteitsnormen.md @@ -1,3 +1,31 @@ # Onze kwaliteitsnormen ## codeconventies +We hebben deze HBO-ICT code conventies aangehouden: +* variabelenaam specificeert inhoud +* variabelenaam in het Engels +* namen met meerdere worden volgen standaard van de taal +* functienamen bevatten werkwoord indien mogelijk +* parameters en return variabelen van functies +* commentaar bij lastige code +* geen onnodig commentaar +* indentatie +* geen overbodige spaties +* geen overbodige lege regels +* geen ongebruikte variabelen +* geen magische getallen +* gebruik van constanten + + +## Samenwerking +* duidelijk laten weten waar we mee bezig zijn +* goede taakverdeling +* samen brainstormen +* elkaar helpen wanneer er problemen optreden + +## Testen +* voordat je code pusht, testen of het werkt +* testen op verschillende laptops zodat we weten dat de game overal op werkt en we niet afhankelijk zijn van 1 laptop +gebruikers: +* duidelijkheid over wat er nog niet werkt voordat ze testen om niet hun tijd te verdoen +* alle feedback opschrijven, maak niet uit hoe dom het is