Plokkkommentaarid

Plokkkommentaarid on kommentaarid, mis katavad mitme rea pikkust koodi. Nende eesmärk on selgitada keerulist loogikat või ajutiselt keelata koodilõikude täitmine, ilma et need kustutatakse. Plokkkommentaarid erinevad ühekordsetest (rea)kommentaaridest, mis puudutavad ainult ühte rida.

Süntaks keelest sõltub. Enamikul C-, C++, Java, JavaScripti ja CSS-i keeltes tähistatakse plokkkommentaarid algusega /* ja lõpetatakse */. HTML-is kasutatakse blokkkommentaare <!-- ja -->. Enamikke programmeerimiskeeli ei toeta kommentaaride sees sisseehitatud lõpetajat, mistõttu ei saa kommentaarisisest osa omavahel “siseneda” või olla suurem kui üks lõpp, mis mõnikord põhjustab süntakslikke probleeme, kui markerid satuvad koodi sees oleval viisil.

Kasutusnõuanded ja piirangud. Plokkkommentaarid on sobivad pikkade selgituste jaoks või koodi osade ajutiseks keelamiseks. Hoia kommentaarid lühikesed, täpsed ja ajakohased ning väldi kordavat või ilmselget infot. Kui kood pidi olema dokumenteeritud API-des, eelistatakse spetsiaalseid dokumentatsioonikomentaaride vorme (näiteks JavaDoc või Doxygen), mitte tavalisi plokkkommentaare.

Kui töötad mitme keele projekti kallal, pea meeles, et iga keel kasutab erinevat süntaksi ja reegleid kommentaaride kohta. Planeeri kommentaaride kasutus vastavalt keele standardidele ja arenduspraktikatele, et neid oleks lihtne mõista ja hooldada.

Näited:

C/Java/JavaScript: /* See on blokkkomentaar

mitmel real */

HTML: <!-- See on kommentaar -->