U ovom ćete vodiču naučiti o JavaScript komentarima, zašto ih trebate koristiti i kako ih koristiti uz pomoć primjera.
JavaScript komentari su natuknice koje programer može dodati kako bi njihov kod bio lakši za čitanje i razumijevanje. JavaScript motori ih potpuno ignoriraju.
Postoje dva načina za dodavanje komentara u kôd:
//- Jednoredni komentari/* */-Višeredni komentari
Jednoredni komentari
U JavaScriptu je svaki redak koji započinje //komentar u jednom retku. Na primjer,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Evo // printing name on the consolekomentara.
Komentar možete koristiti i ovako:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Višeredni komentari
U Javascriptu, bilo koji tekst između /*i */je višeredni komentar. Na primjer,
/* 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. */
Budući da će se ostatak izvornog koda koristiti za provedbu pravila igre, gornji je komentar dobar primjer u kojem možete koristiti komentar u više redaka.
Korištenje komentara za otklanjanje pogrešaka
Komentari se također mogu koristiti za onemogućavanje koda kako bi se spriječilo njegovo izvršavanje. Na primjer,
console.log("some code"); console.log("Error code); console.log("other code");
Ako tijekom pokretanja programa dobijete pogrešku, umjesto uklanjanja koda sklonog pogreškama, možete pomoću komentara onemogućiti njegovo izvršavanje; ovo može biti vrijedan alat za uklanjanje pogrešaka.
console.log("some code"); // console.log("Error code); console.log("other code");
Savjet profesionalca: upamtite prečac za upotrebu komentara; može biti stvarno korisno. Za većinu uređivača koda to je Ctrl + /za Windows i Cmd + /Mac.
Olakšajte razumijevanje koda
Kao programer za JavaScript, ne samo da ćete pisati kôd, već ćete možda morati i mijenjati kôd koji su napisali drugi programeri.
Ako napišete komentare na svoj kôd, bit će vam lakše razumjeti kôd u budućnosti. Također, vašim će kolegama programerima biti lakše razumjeti kod.
Kao opće pravilo, upotrijebite komentare da biste objasnili zašto ste nešto učinili, a ne kako ste nešto učinili, i dobri ste.
Napomena: Komentari ne bi trebali biti zamjena za način objašnjavanja loše napisanog koda na engleskom jeziku. Uvijek biste trebali pisati dobro strukturiran i samorazumljiv kôd. A zatim upotrijebite komentare.
