Megjegyzések a JavaScript-ben

• Április 30, 2024

Csak a megjegyzések, azok a megjegyzések, amelyeket a JavaScript-be vagy a HTML-be tett, hogy megmagyarázza, mi folyik. Számos módon lehet megjegyzéseket fűzni a JavaScript kódhoz. A megjegyzés szintaxisa - hogyan lehet megmondani a szkriptnek vagy a dokumentumnak, hogy valami megjegyzés, és nem adat vagy kód -, nagyon egyszerű. Nehezebb a jó megjegyzéseket írni, és ha a kódot (a sajátomat is) tekintjük, a legnehezebbnek tűnik valójában ezt csinálni!

A JavaScript 2 típusú megjegyzést tartalmaz, egysoros és egysoros megjegyzést.

Az egysoros megjegyzés a JavaScript-ben két előrejelzéssel (//) kezdődik, és a sor végén ér véget (technikailag közvetlenül a vonal-terminátor karakter előtt). Az egysoros megjegyzések különösen hasznosak a rövid jegyzeteknél.

// Ez egy soros megjegyzés
data = "my data" // Ez egy vonalú megjegyzés is

A több soros megjegyzés a JavaScriptben előrejelzővel kezdődik, amelyet csillag követ (/*), és csillaggal végződik, amelyet előrejelző perjel követ (*/). Mindent a /* és */ megjegyzésnek tekintik. Az ilyen típusú megjegyzés több sort is átfedhet. Az ilyen típusú megjegyzés a kódsor közepére is helyezhető, ha nem tartalmaz több sort, de ez ritkán hasznos.

/ * ez egy több soros megjegyzés első sora
ez továbbra is a megjegyzésem része
ez a megjegyzésem utolsó része * /

/ * ez egy soros stílusú megjegyzés egyetlen sorban * /

Gyakran további csillagokat jelenít meg a több soros megjegyzésekhez hozzáadva dekoratív információs mezőket, például:

/*********************
* Saját funkcióim *
*********************/

A többvonalas funkciók különösen hasznosak egy program vagy egy program elején annak leírására, hogy a programot miként tervezik, és hogyan csinálják.

A megjegyzéseket két célra használják. Kód írásakor (vagy akár még mielőtt írná!) Megjegyzéseket kell fűznie, amelyek lehetővé teszik egy másik személy számára, hogy megértse, mit csinál (vagy állítólag csinál) a program, még akkor is, ha nem számít arra, hogy bárki más is elolvassa kódját, meg fog lepődni, mennyit elfelejthet, ha néhány hét vagy hónap elteltével módosítani szeretne.

Ezenkívül, különösen olyan szkriptnyelvekben, mint a JavaScript, a megjegyzéseket gyakran használják a hibakeresési folyamat részeként. Beilleszthet egy kódot a hibakereséshez, és megjegyzéseket fűzhet hozzájuk, ha készen állsz a használatra, vagy megjegyzést fűzhet a kód szakaszaihoz, amelyek véleménye szerint problémákat okoznak, vagy új funkciók hozzáadása céljából megváltoznak. Amikor ezt megteszi, különösen vigyázzon, hogy ne írjon egyetlen soros megjegyzést a sorra a több soros megjegyzés eleje elé. Ez nem vonja vissza a több soros megjegyzés többi részét, amely szinte biztosan hibát fog okozni.

Video Utasításokat: Exploring JavaScript and the Web Audio API by Sam Green and Hugh Zabriskie (Április 2024).