Bij het programmeren op een computer is het soms nodig om notities of opmerkingen achter te laten zodat andere ontwikkelaars gemakkelijk door uw code kunnen bladeren. Of het nu een open source-project of een propriëtair project is, opmerkingen zijn nodig om ook met mede-ontwikkelaars en mogelijke toekomstige ontwikkelaars te kunnen coördineren. Zonder commentaar zou code simpelweg onhoudbaar zijn.
Stappen
Stap 1. Begrijp het doel van het becommentariëren van een computerprogramma
- Leesbaarheid is hier het belangrijkste. Als u naar een opmerking kijkt, moet u weten dat het een opmerking is en geen regel code.
- De opmerking zou ook nuttig moeten zijn, niet alleen voor u, maar voor iedereen die de broncode van uw computerprogramma zou kunnen lezen.
Stap 2. Bedenk een korte, eenvoudige manier om uw punt duidelijk te maken
Opmerkingen hoeven geen kunstwerk te zijn. Ze moeten beknopt, netjes en direct ter zake zijn.
Dit mag echter niet het gebruik van meerdere regels voor een commentaar ontmoedigen. Het gaat erom dat de informatie bij de lezer overkomt
Stap 3. Schrijf de opmerking met de juiste syntaxis die door de programmeertaal wordt gegeven
Stap 4. Vraag jezelf af of de opmerking die je hebt geschreven voldoende gedetailleerd is
Een commentaar zou iemand die naar de broncode kijkt moeten kunnen vertellen wat dat deel van het programma eigenlijk doet zonder het te compileren en uit te voeren. Bereikt uw opmerking dit? Brengt het alle details over?
