Komentarai „JavaScript“

• Gegužė 7, 2024

Komentarai yra tik tai, komentarai, kuriuos įdėjote į „JavaScript“ ar HTML, kad paaiškintumėte, kas vyksta. Yra keletas būdų, kaip komentuoti „JavaScript“ kodą. Komentaro sintaksė - kaip pasakyti scenarijui ar dokumentui, kad kažkas yra komentaras, o ne duomenys ar kodas - labai paprasta. Rašyti gerus komentarus yra sunkiau, o žiūrint į kodą (įskaitant mano pačių), atrodo, kad sunkiausia tai padaryti!

„JavaScript“ yra 2 tipų komentarai: vienos eilutės ir kelių eilučių komentarai.

Vienos eilutės komentaras „JavaScript“ programoje prasideda dviem brūkšniais į priekį (//) ir baigiasi eilutės pabaigoje (techniškai, tiesiai prieš eilutės pasibaigimo ženklą). Vienos eilutės komentarai yra ypač naudingi trumpoms pastaboms.

// Tai vienos eilutės komentaras
data = "mano duomenys" // Tai yra ir vienos eilutės komentaras

Kelių eilučių „JavaScript“ komentaras prasideda pasviruoju brūkšniu, po kurio eina žvaigždutė (/*) ir baigiasi žvaigždute, po kurios eina priekinis brūkšnys (*/). Viskas tarp /* ir */ yra laikomas komentaru. Šis komentaro tipas gali apimti kelias eilutes. Taip pat galima pateikti šio tipo komentarus kodo eilutės viduryje, jei jis neapima kelių eilučių, tačiau tai retai naudinga.

/ * tai yra eilutė iš kelių eilučių komentaro
tai vis dar yra mano komentaro dalis
tai paskutinė mano komentaro dalis * /

/ * tai kelių eilučių stiliaus komentaras vienoje eilutėje * /

Norėdami sukurti dekoratyvinius informacijos laukelius, pavyzdžiui, prie kelių eilučių komentarų matote papildomus žvaigždutes, pvz .:

/*********************
* Mano funkcijos *
*********************/

Kelių eilučių funkcijos yra ypač naudingos programos ar jos dalies pradžioje apibūdinant, ką programa ketina daryti ir kaip ji tai daro.

Komentarai naudojami dviem tikslais. Rašydami kodą (ar net prieš rašydami!) Turėtumėte parašyti komentarus, kurie leis kitam asmeniui suprasti, ką programa daro (ar turėjo daryti). Net jei nesitikite, kad kas nors kitas kada nors skaitys savo kodą, nustebsite, kiek galite pamiršti, jei norite atlikti pakeitimus po kelių savaičių ar mėnesių.

Be to, ypač scenarijų kalbomis, tokiomis kaip „JavaScript“, komentarai dažnai naudojami kaip derinimo proceso dalis. Galite įdėti kodą, skirtą derinti, ir komentuoti juos, kai baigsite juos naudoti, arba komentuokite kodo skyrius, kurie, jūsų manymu, sukelia problemų ar keičiasi, kad pridėtumėte naujų funkcijų. Tai darydami, būkite ypač atsargūs ir nedėkite vienos eilutės komentaro priešais daugia eilutės komentaro pradžią. Tai panaikins likusį kelių eilučių komentarą, kuris beveik neabejotinai sukels klaidą.

Vaizdo Instrukcijos: Javascript 2 - Komentarai (Gegužė 2024).