Noskaidrosim, kas ir komentāri un kāpēc tie ir svarīgi programmēšanā.
Mēs arī aplūkojam divus izplatītākos komentāru veidus un to rakstīšanu 15 dažādās programmēšanas valodās.
Kas ir komentāri programmēšanā?
Komentāri neprofesionāļu izteiksmē ir teksta fragmenti, kas nebūs redzami galalietotājiem un ir paredzēti atsaucei cilvēkiem, kuri raksta kodu.
Nedaudz formālāk komentārs ir programmas apraksts par tās darbību vienkārši lasāmā formātā. Tos parasti izmanto vietās, kur izstrādātājam, kurš lasa kodu, ir jāsniedz papildu skaidrība. Tādējādi tas palīdz uzlabot koda lasāmību un samazina laiku un saziņu, kas būtu nepieciešama zināšanu nodošanai.
Kompilators/tulks vienkārši ignorē komentārus jūsu kodā, tādējādi neietekmējot jūsu programmas gala izvadi. Tātad īsumā komentāri ir kā vienkāršs lasāms skaidrojums noteiktiem koda fragmentiem.
Izplatītākie komentāru veidi
Lielākā daļa programmēšanas valodu atbalsta 2 komentāru veidus.
- Vienas rindiņas komentārs
- Vairāku rindiņu komentārs/komentāru bloķēšana
Kā norāda nosaukums, vienas rindiņas komentāri ir noderīgi, ja nepieciešams pievienot nelielu vienas rindiņas tekstu, piemēram, konkrēts nosacījums, nemainīga vērtība, kurai nepieciešams neliels apraksts. Turpretī vairāku rindiņu rindas darbojas labāk, ja mums ir jāpievieno lielāks informācijas apjoms, piemēram, apraksts par funkciju un to, kā to var izmantot utt.
Ir daži citi komentāru veidi, piemēram, dokumenta komentāri, taču tie neietilpst šī raksta darbības jomā.
Kāpēc jāpievieno komentāri?
“Jebkurš muļķis var uzrakstīt kodu, ko var saprast dators. Labi programmētāji raksta kodu, ko cilvēki var saprast. – Mārtins Faulers
Galvenā komentāru pievienošanas priekšrocība ir uzlabota lasāmība un labāka programmas izpratne. Papildus tam ir dažas citas priekšrocības:
- Komentāri ļauj jūsu vienaudžiem un pat citiem izstrādātājiem ļoti viegli saprast loģiku, nelasot garus dokumentus.
- Samazināta komunikācija starp izstrādātājiem nelielu šaubu dēļ
- Sastādītājs/tulki komentārus ignorē.
- Atvērtā pirmkoda programmatūrai tās ir obligātas, jo jūs nebūsit tur, lai izskaidrotu katru funkciju miljoniem izstrādātāju, kuri vēlas izmantot konkrēto programmu.
Komentāri vairākās valodās
Lieliski, tagad uzzinājām par komentāriem un to, kāpēc tie ir noderīgi. Izpētīsim, kā mēs varam pievienot komentārus dažādās programmēšanas valodās.
Vienas rindiņas komentārs
// This is a single line comment in C/C++
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in C/C++ */
Vienas rindiņas komentārs
# This is a single line comment in Python
Vairāku rindiņu komentārs
# This is slightly long # multi line comment in Python
Vienas rindiņas komentārs
// This is a single line comment in Java
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in Java */
Vienas rindiņas komentārs
# This is a single line comment in Ruby
Vairāku rindiņu komentārs
=begin This is slightly long multi line comment in Ruby =end
Vienas rindiņas komentārs
// This is a single line comment in Golang
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in Golang */
Vienas rindiņas komentārs
– – This is a single line comment in Haskell
Vairāku rindiņu komentārs
{- This is slightly long
multi line comment in Haskell -}
Vienas rindiņas komentārs
// This is a single line comment in Rust
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in Rust */
Vienas rindiņas komentārs
<!-- This is a single line comment in HTML -->
Vairāku rindiņu komentārs
<!-- This is slightly long multi line comment in HTML -->
Vienas rindiņas komentārs
/* This is a single line comment in CSS */
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in CSS */
Vienas rindiņas komentārs
// This is a single line comment in Javascript
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in Javascript */
Vienas rindiņas komentārs
# This is a single line comment in R programming language
Vairāku rindiņu komentārs
R neatbalsta vairāku rindiņu komentārus.
Vienas rindiņas komentārs
% This is a single line comment in Erlang
Vairāku rindiņu komentārs
R neatbalsta vairāku rindiņu komentārus.
Vienas rindiņas komentārs
// This is a single line comment in PHP
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in PHP */
Vienas rindiņas komentārs
# This is a single line comment in Perl
Vairāku rindiņu komentārs
=begin This is slightly long multi line comment in Perl =end
Vienas rindiņas komentārs
// This is a single line comment in Kotlin
Vairāku rindiņu komentārs
/* This is slightly long multi line comment in Kotlin */
Secinājums
Apmācība aptvēra pamatinformāciju par komentāriem un 2 izplatītākajiem veidiem — viena un vairāku rindu. Es arī mēģināju izskaidrot, kāpēc komentāri ir noderīgi, un tie ir jāraksta, kad nepieciešams. Ceru, ka uzzinājāt ko jaunu!
Turpiniet izpēti. Turpini mācīties! 👨💻