Når du programmerer på en computer, er det nogle gange nødvendigt at efterlade noter eller kommentarer, så andre udviklere let kan gennemse din kode. Uanset om det er et open source-projekt eller et proprietært projekt, er der brug for kommentarer for at kunne koordinere med medudviklere og mulige fremtidige udviklere også. Uden kommentarer ville kode simpelthen ikke kunne opretholdes.
Trin
Trin 1. Forstå formålet med at kommentere et computerprogram
- Læsbarhed er det centrale her. Når du ser på en kommentar, skal du vide, at det er en kommentar og ikke en kodelinje.
- Kommentaren bør også være nyttig ikke kun for dig, men for alle andre, der kan læse kildekoden til dit computerprogram.
Trin 2. Tænk på en kort, enkel måde at komme på tværs af din pointe
Kommentarer behøver ikke at være et kunstværk. De skal være kortfattede, pæne og lige til det punkt.
Dette bør imidlertid ikke afskrække brugen af flere linjer til en kommentar. Pointen er, at oplysningerne skal komme videre til læseren
Trin 3. Skriv kommentaren ved hjælp af den relevante syntaks givet af programmeringssproget
Trin 4. Spørg dig selv, om den kommentar, du har skrevet, er detaljeret nok
En kommentar skal kunne fortælle nogen, der ser på kildekoden, hvad den del af programmet rent faktisk gør uden at skulle kompilere det og køre det. Gør din kommentar dette? Giver det alle detaljerne?
