In questo tutorial imparerai a conoscere i commenti JavaScript, perché dovresti usarli e come usarli con l'aiuto di esempi.
I commenti JavaScript sono suggerimenti che un programmatore può aggiungere per rendere il proprio codice più facile da leggere e comprendere. Sono completamente ignorati dai motori JavaScript.
Esistono due modi per aggiungere commenti al codice:
//- Commenti su una riga/* */-Commenti su più righe
Commenti su una riga
In JavaScript, qualsiasi riga che inizia con //è un commento a riga singola. Per esempio,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Ecco // printing name on the consoleun commento.
Puoi anche usare un commento a riga singola come questo:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Commenti su più righe
In Javascript, qualsiasi testo compreso tra /*e */è un commento su più righe. Per esempio,
/* 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. */
Poiché il resto del codice sorgente verrà utilizzato per implementare le regole del gioco, il commento sopra è un buon esempio in cui potresti usare un commento su più righe.
Utilizzo dei commenti per il debug
I commenti possono essere utilizzati anche per disabilitare il codice per impedirne l'esecuzione. Per esempio,
console.log("some code"); console.log("Error code); console.log("other code");
Se si verifica un errore durante l'esecuzione del programma, invece di rimuovere il codice soggetto a errori, è possibile utilizzare i commenti per disabilitarne l'esecuzione; questo può essere un prezioso strumento di debug.
console.log("some code"); // console.log("Error code); console.log("other code");
Suggerimento: ricorda la scorciatoia per usare i commenti; può essere davvero utile. Per la maggior parte degli editor di codice, è Ctrl + /per Windows e Cmd + /per Mac.
Rendi il codice più facile da capire
Come sviluppatore JavaScript, non solo scriverai codice, ma potresti anche dover modificare il codice scritto da altri sviluppatori.
Se scrivi commenti sul tuo codice, sarà più facile per te capire il codice in futuro. Inoltre, sarà più facile per i tuoi colleghi sviluppatori comprendere il codice.
Come regola generale, usa i commenti per spiegare perché hai fatto qualcosa piuttosto che come hai fatto qualcosa, e sei bravo.
Nota: i commenti non dovrebbero sostituire un modo per spiegare il codice scritto male in inglese. Dovresti sempre scrivere codice ben strutturato e autoesplicativo. E poi usa i commenti.
