Javascript-opmerking

| | | | | | | | | | | | | | | | | | | |

JavaScript-opmerkingen worden gebruikt om notities in code te schrijven of om delen van code uit te schakelen zonder ze te verwijderen. Opmerkingen worden in JavaScript gemaakt door // voor een enkele regel toe te voegen of / * voor en * / na meerdere regels.

Reageren op code is een fundamenteel kenmerk van veel programmeertalen. Het idee achter codeopmerkingen is dat hoewel uw code door de computer wordt gelezen, uw code ook door mensen wordt gelezen, dus het is belangrijk dat mensen de code die u schrijft gemakkelijk kunnen begrijpen.

Opmerkingen zijn toegestaan u om uw code bij te houden tijdens het programmeren en u de mogelijkheid te geven om aantekeningen te maken die in de toekomst nuttig kunnen zijn. Als u in een team werkt, zorgt het schrijven van opmerkingen er ook voor dat uw code leesbaar is voor iedereen die mogelijk een bijdrage moet leveren aan uw werk.

In deze zelfstudie bespreken we hoe u opmerkingen kunt schrijven in JavaScript. We beginnen met het bespreken van de waarde van opmerkingen in JavaScript en bekijken vervolgens de syntaxis die u kunt gebruiken om opmerkingen in JavaScript te schrijven.

Opmerkingen schrijven over code

Over de onderwerp is een essentieel onderdeel van het schrijven van leesbare en beheersbare code. De waarheid is dat als je de code die je vandaag schrijft kunt begrijpen, er geen garantie is dat je in staat zult zijn om effectief te beschrijven wat het morgen doet. Als u met andere mensen werkt, is het zeer waarschijnlijk dat zij een deel van de code die u schrijft niet begrijpen.

hier komen opmerkingen binnen. Opmerkingen zijn uitspraken die door de compiler worden genegeerd en kan worden gebruikt om uw JavaScript-code uit te leggen.

Als ontwikkelaar kunt u door opmerkingen over uw code te schrijven, effectiever volgen wat u aan het doen bent. Terwijl u uw code schrijft, kunt u notities maken die u helpen uw code beter te begrijpen en de bedoeling achter de code die u eerder hebt geschreven te begrijpen. Opmerkingen schrijven is ook nuttig voor andere mensen die uw code kunnen zien, omdat de opmerking hen waarschijnlijk zal helpen om dieper te begrijpen hoe uw code werkt.

Elke ontwikkelaar schrijft opmerkingen anders, maar de algemene regel is dat opmerkingen moeten worden gebruikt om de bedoeling achter uw code uit te leggen. Uw code spreekt immers voor zich, maar de redenen om de code op een bepaalde manier te schrijven vaak niet. Daarom kunt u door opmerkingen te schrijven uitleggen waarom u een probleem op een bepaalde manier, waardoor het voor jou en anderen gemakkelijker wordt om later te begrijpen hoe je programma werkt.

JavaScript-opmerkingen

Er zijn twee soorten opmerkingen die in JavaScript worden gebruikt:. Enkele regel opmerkingen en blok opmerkingen

Enkele regel opmerkingen worden geschreven met twee schuine strepen (//) en worden geschreven op één regel code. Elk teken dat volgt op de "//"-declaratie wordt genegeerd tot het einde van de regel. Hier is een voorbeeld van een enkele regel commentaar in JavaScript:

// Dit is een regel commentaar

blok geschreven met de opening en sluitingstags en u kunt opmerkingen als meerdere regels schrijven. De openings- en sluitingstags voor blokreacties zijn:

blokkerende opmerkingen worden soms opmerkingen met meerdere regels genoemd en zien eruit als CSS-opmerkingen met meerdere regels. Hier is een voorbeeld van een blokcommentaar in JavaScript:

Alle code tussen onze openings- en sluitingstags wordt door de compiler genegeerd.

Elke vorm van commentaar kan worden gebruikt om uw code uit te leggen en de bedoeling achter uw code. Hier is een voorbeeld van een opmerking om een declaratie van een basisvariabele uit te leggen:

// Declareer "chocolade"-variabelen om soorten chocolade als een array op te slaan

var chocolate = [` Dark ` ,` Milk `,` White `,` hazelnuts`, `Caramel`];

Opmerkingen in alle programmeertalen ‚Äã‚Äãmoeten regelmatig worden bijgewerkt als de code verandert. Dus als we hebben besloten dat onze variabelenaam zal worden hernoemd tot "chocolate_types", moeten we onze opmerking bijwerken om ervoor te zorgen dat deze de nieuwe variabelenaam weerspiegelt. Programma`s worden zelfs groter, ze veranderen vaak aanzienlijk, dus het is belangrijk om bij te werken de opmerkingen en de code

Commentaar de code

opmerkingen worden vaak gebruikt voor een van twee doeleinden. de eerste, zoals we in dit artikel hebben besproken, is om de bedoeling achter je code uit te leggen en eventuele verwarring op te ruimen. ten tweede is het voorkomen van code-uitvoering tijdens het testen.

Commentaarcode stelt u in staat de uitvoering van een of meer regels code te onderbreken zonder de code volledig uit het programma te verwijderen. Opmerkingen maken is gebruikelijk bij het debuggen, omdat u verschillende oplossingen voor een probleem kunt proberen en de code voor later kunt bewaren

Hier is een voorbeeld van een opmerking waarin een regel code wordt becommentarieerd.

Wanneer we ons programma uitvoeren, zal de compiler de coderegel uitvoeren die de variabele declareert. We hebben commentaar gegeven op de "flavors" omdat het een fout bevat en we het probleem moeten debuggen. In dit geval zijn we vergeten een gelijkteken te plaatsen tussen onze variabelenaam ("flavors") en de waarde van de variabele (onze smaakreeks).

Ofwel splits ze op van de twee soorten opmerkingen die we hebben besproken en onderzoeken hoe ze kunnen worden gebruikt.

eenregelige opmerkingen

eenregelige opmerkingen, ook wel inline-opmerkingen genoemd, worden gebruikt om commentaar te geven op een deel van een regel code of een regel vol code. Hier is een voorbeeld van een JavaScript-opmerking met één regel:

In deze opmerking declareren we een "first_type" variabele die de eerste waarde opslaat in onze "chocolade" tafel . Vervolgens voegen we een inline-opmerking toe aan het einde van onze regel om de bedoeling achter onze code uit te leggen.

Opmerkingen van één regel worden meestal gebruikt om korte opmerkingen over uw code te maken of om de bedoeling achter een specifieke regel code. Opmerkingen met één regel zijn echter niet het enige type opmerking dat u moet gebruiken. Als je een grotere functie wilt uitleggen, kun je het beste blokcommentaar schrijven

bulkcommentaar

bulkcommentaar wordt over meerdere regels geschreven en wordt gebruikt om een groot deel van de code uit te leggen. Hoewel commentaar met één regel meestal een regel code verklaart, kan een commentaarblok een functie of de functie van een bestand.

meerdere regels beginnen bij het begin van een functie of bestand, in de meeste gevallen Hier is een voorbeeld van een blokcommentaar dat wordt gebruikt om een lus uit te leggen:

Onze blokcommentaar omvat t regels van re en wordt gebruikt om code te beschrijven die tien is geschreven in onze "for"-lus.

Blokcommentaar kan ook aan het begin worden gevonden van een bestand om het doel van een bestand uit te leggen of om informatie over de auteur en versie van het bestand op te nemen. Hier is een voorbeeld van een fragment dat de auteur van een bestand en de aanmaakdatum in JavaScript bevat:

Conclusie

Door opmerkingen over de code te schrijven, kunt u in een beter leesbare en onderhoudbare code schrijven. U kunt opmerkingen gebruiken om zowel uw code in de toekomst voor uzelf bij te houden, als om het voor andere mensen die met uw code werken gemakkelijker te maken om het doel ervan te begrijpen.

In deze zelfstudie hebben we de basisprincipes van opmerkingen en onderzocht vervolgens hoe u een JavaScript-opmerking schrijft. We hebben ook de twee belangrijkste typen opmerkingen besproken - eenregelig en meerregelig - en laten voorbeelden zien van elk type opmerkingscode in actie. Ten slotte hebben we de verschillen besproken tussen opmerkingen en codeopmerkingen.

U bent nu klaar om JavaScript-opmerkingen te schrijven als een expert!