- 1 1. Sissejuhatus
- 2 2. C-keele kommentaaride põhitõed
- 3 3. Kommentaaride parimad praktikad
- 4 4. Kommentaaride kasutamise viisid
- 5 5. C-keele kommentaaride kasutamise tähelepanekud
- 6 6. Võrdlus teiste programmeerimiskeeltega
- 7 7. Kokkuvõte
1. Sissejuhatus
Sissejuhatus
Alates algajatest, kes alles õpivad C-keelt, kuni kogenud arendajateni, kes kirjutavad koodi reaalsetes projektides – kommenteerimise oskus on üks programmeerimise olulisi oskusi.
Selles artiklis käsitleme põhjalikult kõiki aspekte alates C-keele kommentaaride põhitõdedest kuni parimate praktikate ja soovitusteni.
Mis on kommenteerimine?
Kommenteerimine tähendab “märget koodis, mis ei mõjuta programmi käitumist”.
Kompilaator ja käitusaeg neid ridu ei töötle, mistõttu on need kasulikud koodi selgitamiseks või silumiseks.
Praktilised kasutusviisid on järgmised:
- Teiste arendajate abistamine koodi mõistmisel
- Enda jaoks hiljem koodi vaatamisel eesmärgi meelde tuletamine
- Koodi ajutine väljalülitamine (silumiseks)
Selliseid kommentaare kasutatakse just nende eesmärkide saavutamiseks.
Miks on kommentaarid C-keeles vajalikud?
1. Koodi loetavuse parandamine
Kuigi programm koosneb lihtsatest käskudest, muutub tegelik kood sageli keerukaks.
Et teistel arendajatel või endal oleks seda hiljem lihtsam mõista, on oluline lisada lühikesi kommentaare, mis täiendavad koodi eesmärki ja toimimist.
Näide:
int a = 5; // Määra muutujale a väärtus 5
2. Silumise efektiivsus
Kui programm ei tööta ootuspäraselt, aitab kommentaaride abil teatud osa koodist ajutiselt välja lülitada.
See võimaldab probleemi asukoha kiiremini kindlaks teha.
Näide:
int a = 5;
// printf("Silumiseks: %d\n", a); // See rida on ajutiselt välja lülitatud
3. Meeskonnatöö ja suhtlus
Meeskonnapõhises arenduses muudavad ja lisavad sama programmi mitu inimest. Kommentaarid on sel juhul olulised, sest ilma selgitusteta kood raiskab aega ja ressursse.
C-keele kommentaaritüübid
C-keeles on kaks peamist kommenteerimisviisi:
- Üherealine kommentaar (
//
sümboliga) - Mitmerealine kommentaar (
/* ... */
sümbolitega)
Järgmistes jaotistes selgitame iga tüübi kasutamist ja tähelepanekuid.
Artikli eesmärk
Selles artiklis käsitleme:
- C-keele kommentaaride põhisüntaks
- Parimad praktikad ja kasutusnäited
- Tähtsad ettevaatusabinõud
mida iga arendaja peaks teadma
Artikkel on kirjutatud nii, et isegi C-keele algajad mõistaksid, kuidas kommentaare kasutada, seega soovitame lugeda lõpuni.
2. C-keele kommentaaride põhitõed
C-keele kommentaaride põhitõed
C-keeles võimaldab kommenteerimine lisada koodile selgitusi või märkusi ning ajutiselt teatud koodi välja lülitada.
Siin selgitame kahte peamist kommenteerimisviisi, mida C-keeles kasutatakse.
Üherealine kommentaar (//
)
Üherealise kommentaari jaoks kasutatakse sümbolit //
(topeltkaldkriips). See sümbol muudab ühe rea koodi kommentaariks.
Põhivorm
int a = 10; // Määra muutujale a väärtus 10
Kasutusnäited
Üherealisi kommentaare kasutatakse lühikeste selgituste või ajutise koodi väljalülitamise jaoks.
Näide 1: Koodi selgitamiseks
#include <stdio.h>
int main() {
int a = 5; // Initsialiseeri muutuja a
printf("a väärtus: %d\n", a); // Väljasta muutuja a väärtus
return 0;
}
Näide 2: Ajutine väljalülitamine silumise ajal
#include <stdio.h>
int main() {
int a = 5;
// printf("Silumiseks: %d\n", a); // See rida on ajutiselt välja lülitatud
return 0;
}
Mitmerealine kommentaar (/* ... */
)
Mitmerealise kommentaari jaoks kasutatakse sümboleid /*
ja */
. See on sobiv pikemate selgituste või mitmerealise koodi väljalülitamiseks.
Põhivorm
/* See on mitmerealine kommentaar.
Seda saab kirjutada mitmel real. */
int a = 10;
Kasutusnäited
Mitmerealisi kommentaare kasutatakse, kui selgitus on pikk või kui on vaja välja lülitada mitu rida koodi.
Näide 1: Pikem selgitus
#include <stdio.h>
int main() {
/* Määra muutujale a väärtus 10
ja seejärel määra b-le väärtus, mis on a kahekordne. */
int a = 10;
int b = a * 2;
printf("b väärtus: %d\n", b);
return 0;
}
Näide 2: Mitme koodirea ajutine väljalülitamine
#include <stdio.h>
int main() {
int a = 5;
/* Järgneva koodi ajutine väljalülitamine
printf("a väärtus: %d\n", a);
a = a + 10;
printf("Muudetud a: %d\n", a);
*/
return 0;
}
Üherealise ja mitmerealise kommentaari valik
Kommentaari tüübi valik sõltub kasutuseesmärgist. Allolev tabel annab ülevaate.
Kommentaari tüüp | Kasutus | Omadused |
---|---|---|
Üherealine kommentaar (// ) | Lühikesed selgitused või ühe rea väljalülitamine | Lihtne ja kiire kirjutada |
Mitmerealine kommentaar (/* ... */ ) | Pikemad selgitused või suurema koodibloki väljalülitamine | Võimaldab korraga kommenteerida mitu rida |
Oluline: Kommentaaride pesastamine pole lubatud
C-keeles ei ole lubatud kommentaaride pesastamine (ehk kommentaari sees uue kommentaari avamine).
Eriti kehtib see mitmerealise kommentaari puhul – /* ... */
sees teise sama tüüpi kommentaari kirjutamine põhjustab vea.
Vea näide
#include <stdio.h>
int main() {
/* See kommentaar tekitab vea.
/* Pesastatud kommentaar */
*/
return 0;
}
Selle vältimiseks tuleks kasutada üherealisi kommentaare ja mitmerealisi kommentaare õigesti kombineerituna.
Kokkuvõte
C-keeles on kaks peamist kommentaaritüüpi: üherealine (//
) ja mitmerealine (/* ... */
).
- Üherealine kommentaar: sobib lühikesteks selgitusteks või ühe rea väljalülitamiseks
- Mitmerealine kommentaar: sobib pikemate selgituste või koodibloki väljalülitamiseks
Nende teadlik ja korrektne kasutamine parandab oluliselt koodi loetavust ja silumise tõhusust.
3. Kommentaaride parimad praktikad
Kommentaaride parimad praktikad
Olenemata sellest, kas tegemist on C-keele või mõne muu programmeerimiskeelega, on kommentaarid koodi mõistmise seisukohalt väga olulised. Kuid kui ei pöörata tähelepanu tõhusatele kommenteerimisviisidele ja vältimist vajavatele harjumustele, võivad need hoopis vähendada loetavust.
Siin kirjeldame kommentaaride kirjutamise parimaid praktikaid.
Kuidas kirjutada häid kommentaare
Kommentaari eesmärk on täiendada koodi selgitustega nii, et selle mõte ja loogika oleks kiiresti arusaadav. Allpool on toodud põhipunktid, mida järgida.
1. Selgita koodi eesmärki
Kommentaar peaks selgitama mitte ainult mida kood teeb, vaid eelkõige miks see nii teeb.
Halb näide:
int a = 5; // Määra muutujale a väärtus 5
Hea näide:
int a = 5; // Sea algväärtuseks 5, et kasutada arvutustes
Selgitus: On ilmne, et a-le antakse väärtus 5. Kuid põhjuse lisamine aitab mõista koodi eesmärki.
2. Selgita keerulist loogikat või algoritme
Kui koodilõik on keeruline, lisa kommentaar, mis selgitab selle toimimist.
Näide:
/* Tsükkel, mis summeerib massiivi elemendid.
Kui massiiv on tühi, tagastatakse 0. */
int sum_array(int arr[], int size) {
int sum = 0;
for (int i = 0; i < size; i++) {
sum += arr[i];
}
return sum;
}
Punkt: Funktsiooni või tsükli rolli selgitamine muudab koodi arusaadavaks ka uuele arendajale.
3. Lisa kommentaarid koodiblokkide ette
Suuremate koodiblokkide ette on hea lisada lühike selgitus nende eesmärgi kohta.
Näide:
#include <stdio.h>
int main() {
// Algseadistus: muutujate deklareerimine ja initsialiseerimine
int a = 5;
int b = 10;
// Arvutus: liida a ja b ning väljasta tulemus
int result = a + b;
printf("Tulemus: %d\n", result);
return 0;
}
Punkt: Kommentaaride lisamine koodiblokkide ette aitab mõista programmi loogikat.
Mida vältida kommentaare kirjutades
1. Väldi liigseid kommentaare
Kui kood on iseenesest arusaadav, ei ole vaja üleliigseid kommentaare. Liigne selgitamine võib loetavust hoopis vähendada.
Halb näide:
int a = 5; // Deklareeri muutuja a ja määra väärtus 5
Hea näide:
int a = 5; // Sea algväärtuseks 5
2. Ära jäta vanu kommentaare alles
Koodi muutmisel tuleb uuendada ka kommentaare. Vastasel juhul tekib vastuolu, mis võib segadust tekitada.
Näide:
/* Funktsioon liidab kaks arvu.
Tegelikult aga korrutab argumendid. */
int calculate(int x, int y) {
return x * y; // Kommentaar ja kood on vastuolus
}
Punkt: Kui muudate koodi, kontrollige alati, et kommentaarid oleksid ajakohased.
3. Vorminda kommentaarid loetavaks
Kasutage kommentaarides sobivaid reavahetusi ja taandamist, et neid oleks lihtne lugeda.
Hea näide:
/* Funktsiooni kirjeldus
-------------------------------
Nimi: add_numbers
Argumendid: int x, int y
Tagastusväärtus: x ja y summa */
int add_numbers(int x, int y) {
return x + y;
}
Kommentaaride sobivad asukohad
Kommentaare on soovitatav paigutada järgmistesse kohtadesse:
- Vahetult koodi ette: funktsiooni või ploki kirjeldus
- Rea lõppu: lühikesed märkused
- Faili päisesse: kogu programmi või faili ülevaade
Näide:
/* Faili ülevaade
---------------------
See programm liidab kaks arvu ja väljastab tulemuse */
#include <stdio.h>
int main() {
int a = 5; // Algväärtus a
int b = 10; // Algväärtus b
// Arvuta ja väljasta tulemus
printf("Tulemus: %d\n", a + b);
return 0;
}
Kokkuvõte
Kommentaaride kirjutamisel tuleks keskenduda koodi eesmärgi selgitamisele ning vältida liigseid või aegunud märkusi. Korralikult kirjutatud kommentaarid parandavad koodi loetavust ja hooldatavust.
- Selgita koodi eesmärki ja põhjuseid
- Täienda keerulist loogikat ja koodiblokke
- Väldi liigseid või eksitavaid kommentaare
Parimate praktikate järgimine teeb meeskonnatöö ja tulevase hoolduse oluliselt lihtsamaks.
4. Kommentaaride kasutamise viisid
Kommentaaride kasutamise viisid
C-keeles ei piirdu kommentaarid ainult koodi selgitamisega – neid saab kasutada ka mitmesugustes praktilistes olukordades. Allpool käsitleme, kuidas kommenteerimist tõhusalt rakendada silumisel, koodi ajutisel väljalülitamisel ja tingimuslikul kompileerimisel.
Koodi väljalülitamine silumise ajal
Silumisel (vigade otsimisel) on sageli vaja teatud koodiridu ajutiselt välja lülitada, et kindlaks teha probleemi asukoht. Kommentaarid on selleks väga kasulikud.
Näide: Silumiseks mõeldud väljundi keelamine
#include <stdio.h>
int main() {
int a = 10, b = 20;
// Silumiseks: kuva muutujate a ja b väärtused
// printf("a = %d, b = %d\n", a, b);
// Ametlik arvutus
int sum = a + b;
printf("Summa: %d\n", sum);
return 0;
}
Punktid:
- Kommentaaride abil saab silumiskoodi kiiresti välja lülitada, et see ei jõuaks tootmiskeskkonda.
- Kommentaari eemaldamisel saab sama koodi uuesti testimiseks kasutada.
Mitme koodirea ajutine väljalülitamine
Kui on vaja välja lülitada suurem osa koodist, on mõistlik kasutada mitmerealist kommentaari (/* ... */
).
Näide: Teatud ploki keelamine
#include <stdio.h>
int main() {
int a = 5;
int b = 10;
/* Järgneva koodi ajutine väljalülitamine
int result = a + b;
printf("Summa: %d\n", result);
*/
printf("Ainult see rida käivitatakse.\n");
return 0;
}
Punktid:
/*
ja*/
abil saab korraga välja lülitada mitu rida.- Sobib eriti testimise ja ajutiste muudatuste tegemiseks.
Tingimuslik kompileerimine ja kommentaarid
C-keeles saab kasutada eeltöötlusdirektiive (#if
, #ifdef
), et teatud kood kompileeritaks ainult kindlatel tingimustel. See sarnaneb kommentaariga, kuid toimub kompileerimise tasemel.
Põhikujul kasutamine
#include <stdio.h>
#define DEBUG 1
int main() {
int a = 5;
#if DEBUG
// Silumisrežiimis kuvatakse väärtus
printf("Debug: a = %d\n", a);
#endif
printf("Programmi töö lõppenud.\n");
return 0;
}
Selgitus:
#if DEBUG
ja#endif
vahel olev kood kompileeritakse ainult siis, kuiDEBUG
on määratud.- Erinevalt kommentaaridest ei jõua see kood üldse kompilaatori väljundisse, kui tingimus pole täidetud.
Kommentaarid koodi selgitamiseks
Kommentaare saab kasutada ka selleks, et täpsustada koodi eesmärki ja loogikat. Eriti oluline on see funktsioonide ja keeruliste algoritmide puhul.
Funktsiooni kirjeldav kommentaar
/*
Funktsioon: calculate_sum
Kirjeldus: Liidab kaks täisarvu ja tagastab summa
Argumendid:
int a - esimene arv
int b - teine arv
Tagastusväärtus: kahe arvu summa
*/
int calculate_sum(int a, int b) {
return a + b;
}
Punktid:
- Kommentaar selgitab funktsiooni rolli ja kasutust.
- Kasulik nii meeskonnatöös kui ka koodirevisjonidel.
Tõhus kommenteerimine
Mõned soovitused kommentaaride tõhusaks kasutamiseks:
- Kasutage kiirklahve
- Enamik arenduskeskkondi ja redaktoreid võimaldavad ühe klahvikombinatsiooniga lisada või eemaldada kommentaare.
- Näited:
- VSCode:
Ctrl + /
(üherealine) - Mitmerealine: vali read ja kasuta
Ctrl + Shift + /
- VSCode:
- Kasuta kommentaare ainult vajadusel
- Silumise või testimise ajal on kommentaarid kasulikud, kuid lõpuks tuleks mittevajalikud eemaldada.
Kokkuvõte
C-keeles saab kommentaare kasutada järgmistel viisidel:
- Koodi ajutine väljalülitamine silumise ajal
- Mitme koodirea korraga väljalülitamine
- Tingimuslik kompileerimine
- Koodi eesmärgi ja loogika selgitamine
Kommentaaride teadlik kasutamine parandab nii koodi loetavust kui ka arenduse efektiivsust.
5. C-keele kommentaaride kasutamise tähelepanekud
C-keele kommentaaride kasutamise tähelepanekud
Kuigi kommentaarid on C-keeles väga kasulikud, võivad nende valed kasutusviisid põhjustada kompileerimisvigu või vähendada koodi loetavust. Allpool selgitame peamisi ettevaatusabinõusid, mida tuleks järgida.
Kommentaaride pesastamine on keelatud
C-keeles ei tohi mitmerealise kommentaari (/* ... */
) sees olla teist samasugust kommentaari. Seda nimetatakse kommentaaride pesastamiseks ja see põhjustab kompileerimisvea.
Vale näide
#include <stdio.h>
int main() {
/* See on kommentaar.
/* Siin on pesastatud kommentaar */
printf("Hello, World!\n");
*/
return 0;
}
Selgitus
- Kompilaator loeb esimest
/*
kuni esimeseni*/
ja lõpetab kommentaari seal. - Sees olev teine kommentaar tekitab tõlgenduse vea.
Õige lahendus
Kui on vaja kommentaare „pesastada”, kasuta üherealisi kommentaare (//
) koos mitmerealistega.
#include <stdio.h>
int main() {
/* See on mitmerealine kommentaar */
// printf("See on üherealine kommentaar ja välja lülitatud");
return 0;
}
Kommentaari eemaldamise unustamine
Silumise või testimise ajal võib mõni koodirida jääda kommentaariks ja ununeda tagasi sisse lülitada. See võib põhjustada olukorra, kus vajalik kood ei käivitu.
Näide
#include <stdio.h>
int main() {
int a = 10;
/* Selle rea väljalülitamine silumise ajal
printf("a väärtus: %d\n", a);
*/
printf("Programm lõppes.\n");
return 0;
}
Lahendus
- Kontrolli alati pärast silumist, et kõik vajalikud read oleksid taas aktiivsed.
- Meeskonnatöös kasuta koodirevisjoni, et vältida liigsete kommentaaride jäämist.
Liigsete kommentaaride vältimine
Kommentaarid peaksid täiendama koodi, mitte seda dubleerima. Liigne selgitamine võib hoopis vähendada loetavust.
Halb näide: koodi dubleeriv kommentaar
int a = 10; // Määra a väärtuseks 10
int b = 20; // Määra b väärtuseks 20
int sum = a + b; // Liida a ja b ja määra sum muutujale
Hea näide: selgita eesmärki
int a = 10;
int b = 20;
// Arvuta ja väljasta kogusumma
int sum = a + b;
printf("Summa: %d\n", sum);
Punktid:
- Kui kood on iseenesest selge, pole vaja iga rida kommenteerida.
- Lisa kommentaar, et selgitada eesmärki, mitte ilmset tegevust.
Kommentaaride kooskõla hoidmine
Koodi muutmisel tuleb alati uuendada ka kommentaare. Kui kommentaarid ei vasta enam koodile, võivad need põhjustada segadust ja vigu.
Halb näide: kommentaar ja kood ei ühti
/* Funktsioon liidab kaks arvu */
int calculate(int a, int b) {
return a * b; // Tegelikult korrutab
}
Hea näide: ajakohastatud kommentaar
/* Funktsioon korrutab kaks arvu */
int calculate(int a, int b) {
return a * b;
}
Lahendus:
- Uuenda kommentaarid iga koodimuudatuse järel.
- Teosta perioodiliselt kommentaaride ja koodi kooskõlastatud ülevaatus.
Kommentaaride ja tootmiskoodi tasakaal
Liiga palju kommentaare tootmiskoodis võib muuta selle raskesti loetavaks. Samuti võib see sisaldada tarbetut infot.
Soovitus
- Eemalda tootmiskoodist kõik mittevajalikud kommentaarid.
- Silumiskoodi puhul kasuta tingimuslikku kompileerimist (
#if DEBUG
).
Kokkuvõte
Peamised tähelepanekud C-keeles kommenteerimisel:
- Väldi kommentaaride pesastamist: ära pane
/* ... */
sisse uut/* ... */
. - Ära unusta kommentaare eemaldada: pärast silumist eemalda ajutised kommentaarid.
- Väldi liigseid kommentaare: kui kood on selge, pole neid vaja.
- Hoia kommentaarid ajakohased: uuenda need koos koodimuudatustega.
- Hoia koodi puhtana: eemalda tootmiskoodist üleliigsed kommentaarid.
Nende põhimõtete järgimine aitab hoida koodi loetavana ja kvaliteetsena.
6. Võrdlus teiste programmeerimiskeeltega
Võrdlus teiste programmeerimiskeeltega
C-keele kommenteerimissüntaks on lihtne, kuid sellel on mõningaid eripärasid võrreldes teiste populaarsete programmeerimiskeeltega. Selles jaotises võrdleme, kuidas kommentaare kasutatakse teistes keeltes, ja toome välja erinevused.
C-keel ja Python
Keel | Üherealine kommentaar | Mitmerealine kommentaar |
---|---|---|
C-keel | // kommentaar | /* mitmerealine kommentaar */ |
Python | # kommentaar | """ mitmerealine kommentaar """ |
Pythonis kommentaaride eripärad
- Üherealine: kasutatakse
#
, lisatakse rea algusesse. - Mitmerealine: spetsiaalset süntaksit pole, kuid
"""
(kolm jutumärki) võimaldab mitmerealist teksti.
Näide Pythonis
# Üherealine kommentaar
x = 5 # Määra muutujale x väärtus 5
"""
Mitmerealine kommentaar
See võib olla dokumentatsiooni või selgituse jaoks
"""
print(x)
C-keel ja Java
Keel | Üherealine kommentaar | Mitmerealine kommentaar |
---|---|---|
C-keel | // kommentaar | /* mitmerealine kommentaar */ |
Java | // kommentaar | /* mitmerealine kommentaar */ ja /** dokumentatsiooni kommentaar */ |
Java kommentaaride eripärad
- Toetab sama süntaksit kui C-keel.
- Lisaks on olemas JavaDoc kommentaarid (
/** ... */
), mida kasutatakse automaatse API dokumentatsiooni loomiseks.
Näide Java-s
/** JavaDoc kommentaar
* See meetod liidab kaks arvu
*/
public int add(int x, int y) {
return x + y;
}
C-keel ja JavaScript
Keel | Üherealine kommentaar | Mitmerealine kommentaar |
---|---|---|
C-keel | // kommentaar | /* mitmerealine kommentaar */ |
JavaScript | // kommentaar | /* mitmerealine kommentaar */ |
JavaScripti kommentaaride eripärad
- Sama süntaks nagu C-keeles.
- Levinud veebiarenduses koodi selgitamiseks ja ajutiseks väljalülitamiseks.
Näide JavaScriptis
// Üherealine kommentaar
let x = 10; // Määra väärtus
/* Mitmerealine kommentaar
See võib kirjeldada funktsiooni või loogikat */
console.log(x);
C-keel ja C++
Keel | Üherealine kommentaar | Mitmerealine kommentaar |
---|---|---|
C-keel | // kommentaar | /* mitmerealine kommentaar */ |
C++ | // kommentaar | /* mitmerealine kommentaar */ |
C++ kommentaaride eripärad
- Kasutab sama süntaksit mis C-keel.
- Tänapäeval kasutatakse enamasti
//
üherealisi kommentaare, sest need on kiiremad kirjutada.
Näide C++-is
// Üherealine kommentaar
int a = 5;
/* Mitmerealine kommentaar
Sobib pikemateks selgitusteks */
std::cout << a << std::endl;
Erinevuste kokkuvõte
Keel | Üherealine | Mitmerealine | Omadused |
---|---|---|---|
C-keel | // | /* ... */ | Lihtne ja kerge süntaks |
Python | # | """ ... """ | Mitmerealise kommenteerimise süntaks erineb C-keelest |
Java | // | /* ... */ , /** ... */ | Toetab JavaDoc dokumentatsiooni kommentaare |
JavaScript | // | /* ... */ | Sama mis C-keeles |
C++ | // | /* ... */ | Kasutab C-keele süntaksit |
Kokkuvõte
C-keele kommentaarisüntaks on lihtne ja koosneb kahest vormist: üherealine kommentaar ja mitmerealine kommentaar.
Teistes keeltes võivad süntaks ja võimalused erineda, näiteks Pythonis kasutatakse #
, Java-s on olemas JavaDoc, kuid üldpõhimõtted on sarnased. C-keele kommentaaride tundmine aitab kiiresti kohaneda ka muude programmeerimiskeeltega.
7. Kokkuvõte
Kokkuvõte
Selles artiklis käsitlesime C-keele kommentaaride kasutamist alates põhitõdedest kuni praktiliste näideteni. Kommentaarid on hädavajalikud, et parandada koodi loetavust ja hooldatavust. Lõpetuseks võtame kokku peamised punktid.
C-keele kommentaaride põhitõed
C-keeles on kaks peamist kommentaaritüüpi:
- Üherealine kommentaar: kasutab
//
ja kommenteerib ühe rea koodi. - Mitmerealine kommentaar: kasutab
/* ... */
ja kommenteerib mitu rida või terve koodibloki.
Nende abil saab lisada selgitusi või ajutiselt koodi välja lülitada.
Kommentaaride praktilised kasutusviisid
Kommentaare saab tõhusalt kasutada järgmistel juhtudel:
- Koodi väljalülitamine silumise ajal: ajutiselt eemaldada probleemne kood testimiseks.
- Mitme rea korraga väljalülitamine: testimiseks või muudatuste kontrollimiseks.
- Tingimuslik kompileerimine:
#if
abil koodi aktiveerimine või keelamine sõltuvalt tingimustest. - Koodi täiendavad selgitused: funktsioonide ja loogika dokumenteerimine.
Kommentaaride kasutamise tähelepanekud
Tõhusaks kommenteerimiseks tuleb järgida mõningaid põhimõtteid:
- Väldi kommentaaride pesastamist: ära kasuta
/* ... */
sees teist sama tüüpi kommentaari. - Väldi liigseid kommentaare: kui kood on selge, pole lisakommentaari vaja.
- Uuenda kommentaare koodi muutmisel: hoia need kooskõlas tegeliku koodiga.
- Väldi eksitavaid kommentaare: vale kommentaar võib segadust tekitada.
Võrdlus teiste keeltes kasutatavate kommentaaridega
C-keele süntaks on lihtne ja intuitiivne, kuid näiteks Python kasutab #
, Java lisab JavaDoc kommentaarid ning teistes keeltes võivad olla oma eripärad. C-keele põhitõdede tundmine muudab ülemineku teistele keeltele lihtsamaks.
Kommentaarid aitavad kirjutada paremat koodi
Kommentaarid ei ole ainult koodi väljalülitamise vahend – need aitavad selgitada koodi eesmärki, kiirendada silumist ja parandada meeskonnatööd.
Heade kommenteerimisvõtete kasutamisel on eelised:
- Parandab koodi loetavust ja hooldatavust
- Muudab silumise ja vigade otsimise kiiremaks
- Teeb koodi arusaadavamaks nii teistele arendajatele kui ka tulevasele endale
Lõpetuseks
Kuigi C-keele kommentaarid on lihtsad, võivad need õigesti kasutades oluliselt parandada programmeerimise efektiivsust ja koodi kvaliteeti. Kasuta käesolevas artiklis toodud parimaid praktikaid ja soovitusi, et kirjutada selget ja hooldatavat koodi.
Jätka C-keele põhitõdede ja edasijõudnute tehnikate õppimist, et luua tõhusat ja professionaalset koodi.