Hvordan skrive kommentarer i JavaScript -koden

Kommentarer er notater om at en programmerer forlater koden sin for å gjøre den mer forståelig. De fleste senior devs fokuserer på å skrive kode som er effektiv og lett kan leses og tolkes av datamaskiner. Imidlertid er det like viktig å gjøre koden lett lesbar for folket (som også vil jobbe med koden i fremtiden). En programmerer må vite hvordan man skal strukturere kode på riktig måte for å gjøre det mer forståelig for mennesker.

Hva er kommentarer?

Kommentarer kan være alt fra en enkelt linjeforklaring til multi-line beskrivelse av kode som er skrevet i kildekoden til et program. De brukes vanligvis til å legge igjen notater i de komplekse delene av kildekoden, slik at alle som ser på koden i fremtiden lett kan forstå formålet med det kodestykket. Denne praksisen sparer tid, da noen lett kan forstå formålet med kode uten å gjøre noen anstrengelser.

La oss nå begynne å lære hvordan du kan strukturere JavaScript -kildekoden på riktig måte ved å skrive forskjellige typer kommentarer:

Typer kommentarer i JavaScript

JavaScript har to hovedtyper av kommentarer:

• Enkeltlinje kommentarer.
• Kommentarer med flere linjer

Enkeltlinje kommentarer: I JavaScript brukes to fremoverlipper (//) til å skrive en-linje kommentarer:

// en enkeltlinje kommentar

Kommentarene på noe programmeringsspråk har ingen effekt på det faktiske programmet. Tolker/kompilatorer av programmeringsspråk er designet på en måte som de ignorerer alle kommentarene når de tolker/sammenstiller et program.

Kommentarer kan ha sine egne separate linjer; De kan også legges til inline med annen kode også.

Inline kommentarer: Når enkeltlinjekommentarer brukes i samme linje som kode, blir de referert til som inline kommentarer:

La a = 30; // en inline kommentar
La B = A + 10; // legge til 10 i "en" variabel og tilordne den til "B"

Inline -kommentarene brukes til å forklare den nøyaktige kodelinjen de er skrevet på; De kan brukes til en spesifikk, liten beskrivelse av koden som er til stede på den linjen.

Kommentarer med flere linjer: I JavaScript er blokkeringskommentarene multi-line kommentarer skrevet på samme måte som de er skrevet i CSS med åpningskoder (/*) og lukkende tagger (*/):

/* En blokk
Kommentar*/

All teksten mellom åpnings- og lukkekodene blir ignorert av tolkerne.

Kommentarer med flere linjer eller kommentarer på blokknivå brukes til å forklare og gi detaljert beskrivelse av en del av koden. Denne typen kommentarer plasseres vanligvis øverst i kildekodefilen eller før en spesielt kompleks kodeblokk:

/* Hente navnet på brukeren
Fra et inngangsfelt
og viser det på konsollen */
funksjon showuser ()
const name = dokument.getElementById ('brukernavn');
konsoll.Logg ("Hei og velkommen til Linuxhint.com, " + navn +".");

Showuser ();

Kommenter kode for testing/feilsøking: Kommentarer kan brukes til å raskt og enkelt forhindre utførelse av en blokkeringskode; Så mange senior JavaScript Devs bruker også kommentarer for testing og feilsøkingsformål. Å plassere kommentarmerker bak en kodeblokk slik at den blir ignorert av tolken og ikke blir utført blir referert til som "Commenting Out Code".

Å kommentere kode hjelper til med å finne årsaken til en feil i koden. De kan også brukes til å teste forskjellige kodeblokker for å få forskjellige resultater:

// funksjon for å dele to tall
funksjonsavdeling (utbytte, divisor)
La Quotient = utbytte / divisor;
returkvotient;

// Funksjon for å trekke fra to tall
funksjon subtraksjon (num1, num2)
La Sub = num1 - num2;
return sub;

/* I den følgende kodelinjen kommenterer vi funksjonssamtalen til divisjonsfunksjonen. Derfor vil bare subtraksjon () -funksjonen bli kalt og utført. */
// divisjon (30, 5);
multiplytwonumbers (9, 3);

Praksis for å skrive god javascript -kode

Her vil vi diskutere de tre beste praksisene for å skrive god JavaScript -kode:

Kommentarer er vanligvis skrevet over kodeblokken de forklarer:

// Vis "Hei, Linuxhint!"På konsollen
konsoll.Logg ("Hei, Linuxhint!");

Indent kommentarer på samme nivå som koden rett under dem:

// Funksjonsdefinisjon
funksjon showuser ()
// hente brukernavnet
const name = dokument.getElementById ('brukernavn');
// Skriv ut meldingen på konsollen
konsoll.Logg ("Hei og velkommen til Linuxhint.com, " + navn +".");

Husk at det ikke er noen måte å avslutte de inline kommentarene på; Så de skal skrives først etter at koden for den linjen er skrevet fullstendig:

for (la i = 0; i === 10; i ++) // for loop som kjører ti ganger
// Å kjøre denne koden resulterer i en syntaksfeil

Konklusjon

Hvor mange ganger har du løst et komplekst problem ved å skrive noen koder bare for å komme tilbake noen måneder senere og finne ut at du husker og forstår ingenting? Kommentarer hjelper deg å unngå det ved å skrive detaljerte forklaringer/beskrivelser av koden din. De hjelper også med å feilsøke testing og pekende kilde til feil i koden din. Både enkelt- og multiline kommentarer kan brukes til feilsøkings-/testformål. Hvis du er en nybegynner JavaScript Dev, bør du skrive så mange kommentarer som mulig i koden din som de er nødvendige for å forstå koden du skriver; Men husk at de bare skal legges til der de trengs.