Comentarii JavaScript (cu exemple)

În acest tutorial, veți afla despre comentariile JavaScript, de ce ar trebui să le utilizați și cum să le utilizați cu ajutorul exemplelor.

Comentariile JavaScript sunt indicii pe care un programator le poate adăuga pentru a facilita citirea și înțelegerea codului lor. Acestea sunt complet ignorate de motoarele JavaScript.

Există două moduri de a adăuga comentarii la cod:

  • // - Comentarii cu o singură linie
  • /* */ -Comentarii cu mai multe linii

Comentarii cu o singură linie

În JavaScript, orice linie care începe cu //este un singur comentariu de linie. De exemplu,

 name = "Jack"; // printing name on the console console.log("Hello " + name); 

Iată // printing name on the consoleun comentariu.

De asemenea, puteți utiliza un singur comentariu de linie astfel:

 name = "Jack"; console.log("Hello " + name); // printing name on the console 

Comentarii pe mai multe linii

În Javascript, orice text între /*și */este un comentariu pe mai multe linii. De exemplu,

 /* 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. */ 

Deoarece restul codului sursă va fi folosit pentru a implementa regulile jocului, comentariul de mai sus este un bun exemplu în care ați putea folosi un comentariu pe mai multe linii.

Utilizarea comentariilor pentru depanare

Comentariile pot fi, de asemenea, utilizate pentru a dezactiva codul pentru a preveni executarea acestuia. De exemplu,

 console.log("some code"); console.log("Error code); console.log("other code");

Dacă primiți o eroare în timp ce rulați programul, în loc să eliminați codul predispus la erori, puteți utiliza comentariile pentru a dezactiva executarea acestuia; acesta poate fi un instrument valoros de depanare.

 console.log("some code"); // console.log("Error code); console.log("other code"); 

Sfat Pro: Rețineți comanda rapidă pentru utilizarea comentariilor; poate fi foarte util. Pentru majoritatea editorilor de cod, este Ctrl + /pentru Windows și Cmd + /pentru Mac.

Faceți codul mai ușor de înțeles

În calitate de dezvoltator JavaScript, nu numai că veți scrie cod, dar poate fi necesar să modificați codul scris de alți dezvoltatori.

Dacă scrieți comentarii asupra codului dvs., vă va fi mai ușor să înțelegeți codul în viitor. De asemenea, colegilor dvs. de dezvoltare le va fi mai ușor să înțeleagă codul.

Ca regulă generală, folosiți comentariile pentru a explica de ce ați făcut ceva mai degrabă decât cum ați făcut ceva și sunteți buni.

Notă: Comentariile nu ar trebui să înlocuiască o modalitate de a explica codul greșit scris în limba engleză. Ar trebui să scrieți întotdeauna un cod bine structurat și auto-explicativ. Și, apoi folosiți comentarii.

Articole interesante...