Ebben az oktatóanyagban megismerheti a JavaScript megjegyzéseket, miért kell használni őket, és hogyan kell felhasználni példák segítségével.
A JavaScript-megjegyzések olyan tippek, amelyeket egy programozó adhat hozzá, hogy könnyebben olvasható és érthetőbb legyen a kódja. A JavaScript-motorok ezeket teljesen figyelmen kívül hagyják.
Kétféle módon adhatunk megjegyzéseket a kódhoz:
//- Egysoros megjegyzések/* */-Többsoros megjegyzések
Egysoros megjegyzések
A JavaScript-ben minden kezdődő //sor egysoros megjegyzés. Például,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Itt // printing name on the consolevan egy megjegyzés.
Használhatja az egysoros megjegyzést is:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Többsoros megjegyzések
A Javascriptben bármely szöveg /*és */egy többsoros megjegyzés. Például,
/* 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. */
Mivel a forráskód többi részét felhasználják a játékszabályok végrehajtására, a fenti megjegyzés jó példa, ahol többsoros megjegyzést használhat.
A Megjegyzések használata a hibakereséshez
A megjegyzéseket a kód letiltására is fel lehet használni, hogy megakadályozzák a végrehajtást. Például,
console.log("some code"); console.log("Error code); console.log("other code");
Ha a program futtatása közben hibát észlel, a hibára hajlamos kód eltávolítása helyett a megjegyzések segítségével letilthatja annak végrehajtását; ez értékes hibakeresési eszköz lehet.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro tipp: Ne feledje a kommentek használatának parancsikonját; valóban hasznos lehet. A legtöbb kódszerkesztő Ctrl + /számára Windows és Cmd + /Mac számára készült.
Tedd a kódot könnyebben érthetővé
JavaScript-fejlesztőként nem csak kódot ír, hanem esetleg módosítania kell más fejlesztők által írt kódot is.
Ha megjegyzéseket ír a kódjára, a jövőben könnyebben megérti a kódot. Emellett a fejlesztőtársak is könnyebben megértik a kódot.
Általános ökölszabályként a megjegyzésekkel magyarázza el, miért tett valamit, nem pedig azt , hogy hogyan tett valamit, és jó vagy.
Megjegyzés: A megjegyzések nem helyettesíthetik a rosszul írt kód angol nyelvű magyarázatát. Mindig jól felépített és magától értetődő kódot kell írni. És akkor használja a megjegyzéseket.
