Šajā apmācībā jūs uzzināsit par JavaScript komentāriem, kāpēc tie jālieto un kā tos izmantot, izmantojot piemērus.
JavaScript komentāri ir padomi, kurus programmētājs var pievienot, lai padarītu viņu kodu vieglāk lasāmu un saprotamu. JavaScript dzinēji tos pilnībā ignorē.
Ir divi veidi, kā pievienot komentārus kodam:
//- Vienrindas komentāri/* */-Daudzlīniju komentāri
Vienrindas komentāri
JavaScript valodā jebkura rinda, kas sākas ar, //ir vienas rindiņas komentārs. Piemēram,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Šeit // printing name on the consoleir komentārs.
Varat arī izmantot šādas vienrindas komentārus:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Daudzrindu komentāri
Javascriptā jebkurš teksts starp /*un */ir vairākrindu komentārs. Piemēram,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Tā kā pārējais avota kods tiks izmantots spēles noteikumu ieviešanai, iepriekš sniegtais komentārs ir labs piemērs, kur jūs varat izmantot vairāku rindiņu komentāru.
Komentāru izmantošana atkļūdošanai
Komentārus var izmantot arī, lai atspējotu kodu, lai novērstu tā izpildi. Piemēram,
console.log("some code"); console.log("Error code); console.log("other code");
Ja, palaižot programmu, tiek parādīta kļūda, tā vietā, lai noņemtu kļūdainu kodu, varat izmantot komentārus, lai atspējotu tā izpildi; tas var būt vērtīgs atkļūdošanas rīks.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro padoms: atcerieties komentāru izmantošanas saīsni; tas var būt patiešām noderīgs. Lielākajai daļai kodu redaktoru tā ir Ctrl + /paredzēta operētājsistēmai Windows un Cmd + /Mac.
Padariet kodu vieglāk saprotamu
Kā JavaScript izstrādātājs jūs ne tikai rakstīsit kodu, bet, iespējams, būs jāmaina arī citu izstrādātāju uzrakstītais kods.
Ja jūs rakstīsit komentārus par savu kodu, jums būs vieglāk saprast kodu nākotnē. Arī citiem izstrādātājiem būs vieglāk saprast kodu.
Parasti pēc īkšķa noteikuma izmantojiet komentārus, lai paskaidrotu, kāpēc jūs kaut ko izdarījāt, nevis kā jūs kaut ko izdarījāt, un jums ir labi.
Piezīme. Komentāri nedrīkst aizstāt veidu, kā izskaidrot slikti uzrakstītu kodu angļu valodā. Jums vienmēr jāraksta labi strukturēts un pašsaprotams kods. Un pēc tam izmantojiet komentārus.
