Come scrivere commenti nel codice JavaScript

I commenti sono note che un programmatore lascia nel loro codice per renderlo più comprensibile. La maggior parte degli sviluppatori senior si concentra sulla scrittura di codice che è efficiente e può essere facilmente letta e interpretata dai computer. Tuttavia è di pari importanza rendere il codice facilmente leggibile per le persone (che lavoreranno anche con il codice in futuro). Un programmatore deve sapere come strutturare correttamente il codice per renderlo più comprensibile per gli umani.

Quali sono i commenti?

I commenti possono essere qualsiasi cosa, dalla spiegazione di una singola riga alla descrizione multi-riga del codice scritto all'interno del codice sorgente di un programma. Di solito vengono utilizzati per lasciare note nelle parti complesse del codice sorgente in modo che chiunque guardino il codice in futuro possa facilmente comprendere lo scopo di quel pezzo di codice. Questa pratica risparmia tempo poiché chiunque può comprendere facilmente lo scopo del codice senza fare alcuno sforzo.

Ora iniziamo a imparare come strutturare correttamente il codice sorgente JavaScript scrivendo diversi tipi di commenti:

Tipi di commenti in JavaScript

JavaScript ha due tipi principali di commenti:

• Commenti a linea singola.
• Commenti multi-line

Commenti a linea singola: In JavaScript due Slash Forward (//) vengono utilizzate per scrivere commenti a linea singola:

// un commento a linea singola

I commenti in qualsiasi linguaggio di programmazione non hanno alcun effetto sul programma effettivo. Gli interpreti/compilatori dei linguaggi di programmazione sono progettati in modo da ignorare tutti i commenti durante l'interpretazione/compilazione di un programma.

I commenti possono avere le proprie linee separate; Possono anche essere aggiunti in linea con altri codice.

Commenti in linea: Quando i commenti a linea singola vengono utilizzati nella stessa riga del codice, vengono indicati come commenti in linea:

Lascia che a = 30; // un commento in linea
Sia b = a + 10; // aggiungendo 10 in "A" variabile e assegnandolo a "B"

I commenti in linea sono usati per spiegare la riga esatta di codice su cui sono scritti; Possono essere utilizzati per una descrizione specifica e piccola del codice presente in quella riga.

Commenti multi-line: In JavaScript i commenti del blocco I commenti multi-line sono scritti allo stesso modo in cui sono scritti in CSS con tag di apertura (/*) e tag di chiusura (*/)

/* Un blocco
Commento*/

Tutto il testo tra i tag di apertura e chiusura è ignorato dagli interpreti.

I commenti multi-line o i commenti a livello di blocco vengono utilizzati per spiegare e fornire una descrizione dettagliata di una sezione di codice. Questo tipo di commenti è generalmente posizionato nella parte superiore del file di codice sorgente o prima di un blocco di codice particolarmente complesso:

/* Presa il nome dell'utente
Da un campo di input
e mostrarlo sulla console */
funzione showUser ()
const name = document.getElementById ('User-Name');
console.Log ("Ciao e benvenuto al Linuxhint.com, " + nome +".");

showuser ();

Commentando il codice per test/debug: I commenti possono essere utilizzati per impedire rapidamente e facilmente l'esecuzione di un codice a blocchi; Così tanti sviluppatori di Javascript senior usano anche commenti per scopi di test e debug. Posizionare i tag di commento dietro un blocco di codice in modo che venga ignorato dall'interprete e non viene eseguito viene definito "commento di codice".

Il commento del codice aiuta a individuare la causa di un errore nel codice. Possono anche essere usati per testare diversi blocchi di codice per ottenere risultati diversi:

// funzione per dividere due numeri
Divisione funzioni (dividendo, divisore)
let quoziente = dividendo / divisore;
quoziente di ritorno;

// funzione per sottrarre due numeri
function sottraction (num1, num2)
let sub = num1 - num2;
Sub di ritorno;

/* Nella seguente riga di codice, stiamo commentando la funzione funzione della funzione di divisione. Pertanto, verrà chiamata ed eseguita solo la funzione di sottrazione (). */
// divisione (30, 5);
multiplytwonumbers (9, 3);

Pratiche per scrivere un buon codice JavaScript

Qui discuteremo delle tre migliori pratiche per scrivere un buon codice JavaScript:

I commenti sono generalmente scritti sopra il blocco del codice che stanno spiegando:

// Mostra "Ciao, Linuxhint!"Sulla console
console.log ("Ciao, Linuxhint!");

Commenti di rientro allo stesso livello del codice immediatamente sotto di loro:

// Definizione della funzione
funzione showUser ()
// recupera il nome utente
const name = document.getElementById ('User-Name');
// Stampa il messaggio sulla console
console.Log ("Ciao e benvenuto al Linuxhint.com, " + nome +".");

Ricorda che non c'è modo di porre fine ai commenti in linea; Quindi dovrebbero essere scritti solo dopo che il codice per quella riga è stato scritto completamente:

per (let i = 0; i === 10; i ++) // per loop che funziona dieci volte
// L'esecuzione di questo codice provoca un errore di sintassi

Conclusione

Quante volte hai risolto un problema complesso scrivendo un po 'di codice solo per tornare qualche mese dopo e scoprire che ricordi e non capisci nulla? I commenti ti aiutano a evitarlo scrivendo spiegazioni/descrizioni dettagliate del tuo codice. Aiutano anche a debug di test e individuare la fonte di errori nel codice. Sia i commenti singoli che multiline possono essere utilizzati per scopi di debug/test. Se sei un Dev per principianti JavaScript, dovresti scrivere il maggior numero possibile di commenti nel tuo codice che sono necessari per comprendere il codice che scrivi; ma ricorda che dovrebbero essere aggiunti solo dove sono necessari.