Kommentarer i JavaScript

• April 30, 2024

Kommentarer är bara det, kommentarer som du lägger i din JavaScript eller HTML för att förklara vad som händer. Det finns flera sätt att lägga kommentarer i din JavaScript-kod. Kommentarsyntax - hur man säger manus eller dokument att något är en kommentar och inte data eller kod - är mycket enkelt. Att skriva bra kommentarer är svårare, och från att titta på kod (min egen ingår) verkar den svåraste delen faktiskt göra det!

JavaScript har två typer av kommentarer, en enstaka radskommentar och en flersidig kommentar.

Den enda radkommentaren i JavaScript börjar med två framåt snedstreck (//) och slutar i slutet av raden (tekniskt, strax före linjeterminatortecknet). Kommentarer med en rad är särskilt användbara för korta anteckningar.

// Detta är en kommentar på en rad
data = "mina data" // Det här är en enda radkommentar

En kommentar med flera linjer i JavaScript börjar med en framåtstreck följt av en asterisk (/*) och avslutas med en asterisk följt av en framåt snedstreck (*/). Allt mellan /* och */ anses vara en kommentar. Den här typen av kommentarer kan sträcka sig över flera rader. Det är också möjligt att placera denna typ av kommentarer i mitten av en kodrad, om den inte sträcker sig över flera rader, men det är sällan användbart.

/ * detta är rad en av en flersträngskommentar
detta är fortfarande en del av min kommentar
detta är den sista delen av min kommentar * /

/ * detta är en flerstreckad kommentar på en enda rad * /

Du ser ofta extra asterisker läggs till i flera linjekommentarer för att skapa dekorativa informationsrutor, till exempel:

/*********************
* Mina funktioner *
*********************/

Multilinjefunktioner är särskilt användbara i början av ett program eller en del av ett program för att beskriva vad programmet är avsett att göra och hur det gör det.

Kommentarer används för två ändamål. När du skriver kod (eller till och med innan du skriver den!) Bör du skriva kommentarer som gör att en annan person kan förstå vad programmet gör (eller ska göra.) Även om du inte förväntar dig att någon annan någonsin ska läsa din kod, blir du förvånad över hur mycket du kan glömma om du vill göra ändringar efter några veckor eller månader.

Också, särskilt på skriptspråk som JavaScript, används ofta kommentarer som en del av felsökningsprocessen. Du kan lägga in kod som ska användas för felsökning och kommentera dem när du är klar med att använda dem eller kommentera delar av koden som du tror orsakar problem eller ändrar för att lägga till ny funktionalitet. När du gör det ska du vara särskilt försiktig så att du inte lägger en enstaka radkommentar på raden framför början av en flersidig kommentar. Detta avgränsar resten av kommentarerna i flera linjer, vilket nästan säkert kommer att orsaka ett fel.

Video Instruktioner: Bokanbefaling #1: You Don't Know JS (April 2024).