Programmējot datorā, dažreiz ir jāatstāj piezīmes vai komentāri, lai citi izstrādātāji varētu viegli pārlūkot jūsu kodu. Neatkarīgi no tā, vai tas ir atvērtā pirmkoda projekts vai patentēts projekts, komentāri ir nepieciešami, lai tos saskaņotu ar līdzizstrādātājiem un iespējamiem nākotnes izstrādātājiem. Bez komentāriem kods vienkārši nebūtu uzturējams.
Soļi
Solis 1. Izprotiet datorprogrammas komentēšanas mērķi
- Lasāmība šeit ir galvenais. Aplūkojot komentāru, jums jāzina, ka tas ir komentārs, nevis koda rindiņa.
- Komentāram vajadzētu būt noderīgam ne tikai jums, bet arī jebkuram citam, kas varētu nolasīt jūsu datorprogrammas avota kodu.
2. solis. Padomājiet par īsu, vienkāršu veidu, kā izteikt savu viedokli
Komentāriem nav jābūt mākslas darbiem. Tiem jābūt kodolīgiem, glītiem un tiešiem.
Tomēr tam nevajadzētu atturēt no vairāku rindiņu izmantošanas komentāram. Lieta ir tāda, ka informācijai ir jānonāk pie lasītāja
3. solis. Uzrakstiet komentāru, izmantojot atbilstošo programmēšanas valodas sintaksi
4. solis. Pajautājiet sev, vai jūsu rakstītais komentārs ir pietiekami detalizēts
Komentāram vajadzētu spēt pateikt kādam, kas skatās uz avota kodu, ko šī programmas daļa faktiski dara, bez nepieciešamības to apkopot un palaist. Vai jūsu komentārs to sasniedz? Vai tas atspoguļo visas detaļas?
