Inhoudsopgave:
Definitie - Wat betekent commentaar?
Een opmerking is een speciale constructie in een programmeertaal waarmee de programma-ontwikkelaar aanvullende informatie over het programma kan vermelden. De belangrijkste reden voor het opnemen van opmerkingen in programmeertalen is het verbeteren van de draagbaarheid en onderhoudbaarheid van een code.
Techopedia legt commentaar uit
Vaak werken software-ontwikkelingsteams samen aan verschillende softwaremodules, die tijdens het testproces door testingenieurs worden geïnspecteerd. Tijdens het testproces moeten de ingenieurs op de hoogte zijn van de werking van een module. Daarom worden opmerkingen door de ontwikkelaar opgenomen om de werking van een bepaalde module uit te leggen door de geldige soorten ingangen, het aantal ingangen, het algoritme dat wordt gebruikt voor verwerking in de interne module, de verwachte uitgangen en de foutcondities die kunnen optreden tijdens verwerking.
Opmerkingen bevatten vaak ook informatie over de auteur van de inhoud, de datum en tijd waarop deze is ontwikkeld en de datum en tijd waarop deze voor het laatst is gewijzigd. Hoeveel details moeten worden vermeld, is een kwestie van subjectiviteit. Sommige ontwikkelaars zijn berucht omdat ze reacties haten en ze als tijdverspilling zien. Voor anderen zijn opmerkingen een absolute noodzaak. In theorie zou een organisatie alle coderingsnormen moeten vaststellen. Toch, om welke reden dan ook, zal iemand die code heeft geërfd van een eerder ontwikkelteam je vaker vertellen dan niet dat de code niet de opmerkingen heeft die ze graag zouden willen zien.
