Hvordan skrive en kommentar på et dataprogrammeringsspråk: 4 trinn

Innholdsfortegnelse:

Hvordan skrive en kommentar på et dataprogrammeringsspråk: 4 trinn
Hvordan skrive en kommentar på et dataprogrammeringsspråk: 4 trinn

Video: Hvordan skrive en kommentar på et dataprogrammeringsspråk: 4 trinn

Video: Hvordan skrive en kommentar på et dataprogrammeringsspråk: 4 trinn
Video: Hvordan lage en kul overskrift. 2024, Mars
Anonim

Når du programmerer på en datamaskin, er det noen ganger nødvendig å legge igjen notater eller kommentarer slik at andre utviklere enkelt kan bla gjennom koden din. Enten det er et åpen kildekode-prosjekt eller et proprietært prosjekt, er kommentarer nødvendig for å koordinere med medutviklere og mulige fremtidige utviklere også. Uten kommentarer ville koden rett og slett ikke kunne opprettholdes.

Trinn

Skriv en kommentar i et dataprogrammeringsspråk Trinn 1
Skriv en kommentar i et dataprogrammeringsspråk Trinn 1

Trinn 1. Forstå formålet med å kommentere et dataprogram

  • Lesbarhet er det viktigste her. Når du ser på en kommentar, bør du vite at det er en kommentar og ikke en kodelinje.
  • Kommentaren bør også være nyttig ikke bare for deg, men for alle andre som kan lese kildekoden til dataprogrammet ditt.
Skriv en kommentar i et dataprogrammeringsspråk Trinn 2
Skriv en kommentar i et dataprogrammeringsspråk Trinn 2

Trinn 2. Tenk på en kort, enkel måte å komme over poenget ditt

Kommentarer trenger ikke å være et kunstverk. De skal være konsise, ryddig og rett til poenget.

Dette bør imidlertid ikke motvirke bruk av flere linjer for en kommentar. Poenget er at informasjonen må komme frem til leseren

Skriv en kommentar i et dataprogrammeringsspråk Trinn 3
Skriv en kommentar i et dataprogrammeringsspråk Trinn 3

Trinn 3. Skriv kommentaren ved hjelp av passende syntaks gitt av programmeringsspråket

Skriv en kommentar på et språk for datamaskinprogrammering Trinn 4
Skriv en kommentar på et språk for datamaskinprogrammering Trinn 4

Trinn 4. Spør deg selv om kommentaren du har skrevet er detaljert nok

En kommentar skal kunne fortelle noen som ser på kildekoden hva den delen av programmet faktisk gjør uten å måtte kompilere den og kjøre den. Oppnår kommentaren din dette? Overfører den alle detaljene?

Anbefalt: