När du programmerar på en dator är det ibland nödvändigt att lämna anteckningar eller kommentarer så att andra utvecklare enkelt kan bläddra i din kod. Oavsett om det är ett projekt med öppen källkod eller ett eget projekt, behövs kommentarer för att samordna med medutvecklare och eventuella framtida utvecklare också. Utan kommentarer skulle koden helt enkelt vara ohållbar.
Steg
Steg 1. Förstå syftet med att kommentera ett datorprogram
- Läsbarhet är det viktigaste här. När du tittar på en kommentar bör du veta att det är en kommentar och inte en kodrad.
- Kommentaren bör också vara till hjälp inte bara för dig, utan för alla andra som kan läsa källkoden till ditt datorprogram.
Steg 2. Tänk på ett kort, enkelt sätt att komma över din poäng
Kommentarer behöver inte vara ett konstverk. De ska vara korta, snygga och raka till sak.
Detta bör dock inte avskräcka från att använda flera rader för en kommentar. Poängen är att informationen behöver komma över till läsaren
Steg 3. Skriv kommentaren med lämplig syntax från programmeringsspråket
Steg 4. Fråga dig själv om kommentaren du har skrivit är tillräckligt detaljerad
En kommentar bör kunna berätta för någon som tittar på källkoden vad den delen av programmet faktiskt gör utan att behöva kompilera den och köra den. Uppnår din kommentar detta? Förmedlar den alla detaljer?
