Kommentaarid JavaScriptis

• Mai 16, 2024

Kommentaarid on lihtsalt sellised, kommentaarid, mille panite oma JavaScripti või HTML-i, et selgitada, mis toimub. Oma JavaScripti koodi saab kommentaaride lisamiseks mitmeid viise. Kommentaari süntaks - kuidas öelda skriptile või dokumendile, et midagi on kommentaar, mitte andmed või kood - on väga lihtne. Heade kommentaaride kirjutamine on raskem ja koodist (minu oma kaasa arvatud) vaadates tundub, et kõige raskem on tegelikult seda teha!

JavaScriptil on 2 tüüpi kommentaare, üherealine ja mitmerealine kommentaar.

JavaScripti ühe rea kommentaar algab kahe kaldkriipsuga (//) ja lõpeb rea lõpus (tehniliselt vahetult enne rea lõpetaja märki). Üherealised kommentaarid on eriti kasulikud lühikeste märkmete jaoks.

// See on üherealine kommentaar
data = "minu andmed" // Ka see on üherealine kommentaar

Mitmerealine kommentaar JavaScriptis algab kaldkriipsuga, millele järgneb tärn (/*) ja lõpeb tärniga, millele järgneb kaldkriips (*/). Kõik vahel /* ja */ peetakse kommentaariks. Seda tüüpi kommentaarid võivad hõlmata mitut rida. Seda tüüpi kommentaari on võimalik panna ka koodirea keskele, kui see ei hõlma mitut rida, kuid see on harva kasulik.

/ * see on mitmerealine kommentaar esimene rida
see on endiselt osa minu kommentaarist
see on minu kommentaari viimane osa * /

/ * see on mitmerealine kommentaar ühel real * /

Dekoratiivsete teabekastide loomiseks näete mitmerealistel kommentaaridel sageli lisatärnid, näiteks:

/*********************
* Minu funktsioonid *
*********************/

Mitmerealised funktsioonid on eriti kasulikud programmi või programmi lõigu alguses, et kirjeldada, mida programm kavatseb teha ja kuidas see seda teeb.

Kommentaare kasutatakse kahel eesmärgil. Koodi kirjutades (või isegi enne selle kirjutamist!) Peaksite kirjutama kommentaare, mis võimaldavad teisel inimesel mõista, mida programm teeb (või peaks tegema). Isegi siis, kui te ei eelda, et keegi teine ​​kunagi loeb oma koodi, siis olete üllatunud, kui palju võite unustada, kui soovite muudatusi teha mõne nädala või kuu pärast.

Samuti kasutatakse kommentaare silumisprotsessi osana eriti skriptikeeltes, nagu JavaScript. Võite silumiseks kasutada koodi ja neid kommenteerida, kui olete nende kasutamise lõpetanud, või kommenteerida koodilõike, mis teie arvates tekitavad probleeme või muutuvad uute funktsioonide lisamiseks. Seda tehes olge eriti ettevaatlik, et ärge pange reale ühe rea kommentaari mitme rea algusesse. See kommenteerib ülejäänud mitmerealist kommentaari, mis põhjustab peaaegu kindlasti tõrke.

Video Juhiseid: Mallukas ja kurjad kommentaarid (Mai 2024).