Comments #1
Description
Je hebt feedback gekregen van SilvanDomino
URL: https://github.com/Wopsie/DialogueSystem/blob/master/Dialogue System/Assets/Scripts/XMLReading/XmlReader.cs
Feedback: De bedoeling van comments is dat deze uitleggen wat code doen. De drie comments die je hebt gemaakt doen dat niet (volledig). Zeker bij langere, ingewikkeldere fucties (waarvan ReadSubnodes er zeker een is) zorg dat deze goed gecomment is. Schrijf daarboven een uitleg wat deze doet door bijvoorbeeld de input, de output en de implementatie van de functie te omschrijven.
Wanneer andere mensen jouw code gaan lezen is het erg belangrijk als er comments bij staan om jouw code leesbaar te maken. Vooral bedrijven zullen dat erg op prijs stellen.
Je komt zometeen een half jaar bij een bedrijf te werken, en wanneer jouw stage is afgelopen, gaat het bedrijf door met jouw code. Daarom is het essentieel dat de mensen bij jouw stage bedrijf begrijpen wat jouw code doet zonder elke regel te hoeven doornemen.