Si të shkruani komente në JavaScript

Prezantimi

Në programim, konsiderata jonë e parë është zakonisht makina - se si kompjuteri po lexon dhe interpreton kodin që ne shkruajmë. Sidoqoftë, është po aq e rëndësishme të merren parasysh njerëzit që do të lexojnë dhe punojnë me kodin. Pavarësisht nëse jeni duke punuar me një ekip ose vetë, do t'ju duhet të mësoni të komentoni dhe strukturoni siç duhet kodin tuaj për lexuesit njerëzorë.

Komentet janë shënime në kodin burimor të një programi që injorohen nga interpretuesi dhe për këtë arsye nuk kanë asnjë efekt në daljen aktuale të kodit. Komentet mund të jenë jashtëzakonisht të dobishme për të shpjeguar qëllimin e asaj që është ose duhet të bëjë kodi juaj.

Si zhvillues, mund të jetë zhgënjyese të hulumtosh në kodin e shkruar nga dikush tjetër që nuk është komentuar siç duhet dhe është jashtëzakonisht e lehtë të harrosh se çfarë nënkuptonte kodi yt kur nuk je më i zhytur në kontekstin e një programi. Komentimi i kodit tuaj herët do të përforcojë zakonet e mira të programimit gjatë gjithë karrierës suaj për të shmangur këto çështje më vonë.

Sintaksa e komenteve

Le të hedhim një vështrim të shpejtë në dy llojet e ndryshme të sintaksës së komenteve JavaScript.

Komentet me një rresht shkruhen me dy prerje përpara (//):

// This is a comment

Të gjithë karakteret që pasojnë menjëherë sintaksën // deri në fund të rreshtit do të injorohen nga JavaScript.

Komentet Blloko, të referuara ndonjëherë si komente mutli-line, shkruhen me etiketat hapëse (/*) dhe etiketat mbyllëse (* /). Nëse e dini CSS, atëherë tashmë jeni njohur me komentet e nivelit të bllokut.

/* This is
a comment */

Çdo gjë ndërmjet etiketës hapëse dhe mbyllëse në bllokun e kodit të mësipërm do të shpërfillet.

Komentet me një rresht dhe me shumë rreshta janë shkruar mbi kodin që ata janë caktuar për të shpjeguar, siç tregohet në këtë Përshëndetje, Botë! shembull:

// Print "Hello, World!" to the console
console.log("Hello, World!");

Kur shkruani komente, futini ato në të njëjtin nivel me kodin menjëherë poshtë tyre:

// Initialize a function
function alphabetizeOceans() {
	// Define oceans variable as a list of strings
	const oceans = ["Pacific", "Atlantic", "Indian", "Antarctic", "Arctic"];

	// Print alphabetized array to the console
	console.log(oceans.sort());
}

Vini re se komentet janë po aq pjesë e kodit sa edhe vetë programi. Komentet e vjetruara mund të jenë më shumë dëm sesa mos komenti fare, prandaj mos harroni të mbani dhe përditësoni rregullisht komentet së bashku me gjithçka tjetër.

Komentet në linjë

Komentet me një rresht quhen komente të brendshme kur shfaqen në fund të një rreshti kodi.

let x = 99;    // assign numerical value to x
let y = x + 2; // assign the sum of x + 2 to y

Komentet inline mund të përdoren për shënime të shpejta në fragmente të vogla, specifike të përmbajtjes. Meqenëse komenti duhet të lidhet vetëm me rreshtin e saktë ku është shkruar, ai është lloji më i dukshëm i komentit.

Mos harroni se nuk ka asnjë mënyrë për të përfunduar një koment të vetëm rreshti në një rresht, prandaj sigurohuni që të mos vendosni asnjë kod pas sintaksës //, siç shihet në shembullin më poshtë.

for (let i = 0; i === 10; i++) // for loop that runs ten times {
	// Running this code results in a syntax error
}

Megjithëse komentet inline mund të jenë të dobishme, ato duhet të përdoren me masë - kodi i mbuluar me një bollëk komentesh inline do të bëhet shpejt i çrregullt dhe për këtë arsye i vështirë për t'u lexuar.

Blloko komentet

Komentet e nivelit të bllokut, ose komentet me shumë rreshta, janë shënime të gjata që përdoren për të prezantuar dhe shpjeguar një pjesë të kodit. Shpesh këto lloj komentesh vendosen në krye të një skedari, ose përpara një blloku kodi veçanërisht kompleks.

/* Initialize and invoke a the greetUser function
to assign user's name to a constant and print out
a greeting. */

function greetUser() {
	const name = prompt("What is your name?");
	console.log("Hello ," + name + "! How are you?");
}

greetUser();

Ju gjithashtu mund të shihni ndonjëherë një version pak të modifikuar të sintaksës së komenteve të bllokut, i cili fillon me /** dhe përfshin yjet në të gjithë anën e majtë të bllokut të komenteve.

/**
 * Initialize constant with an array of strings.
 * Loop through each item in the array and print
 * it to the console.
 */

const seaCreatures = ["Shark", "Fish", "Octopus"];

for (const seaCreature of seaCreatures) {
  console.log(seaCreature);
}

Ndonjëherë ky lloj komenti do të përfshijë gjithashtu detaje rreth skedarit të programimit, duke përfshirë emrin, versionin dhe autorin e skenarit.

Nëse jeni fillestar në JavaScript, mund të shkruani aq sa është e nevojshme për të mësuar dhe kuptuar kodin që shkruani. Ndërsa përparoni si një zhvillues JavaScript, do të kërkoni t'i përgjigjeni qëllimit ose pse pas kodit, në krahasim me si ose çfarë.

Komentimi i Kodit për Testim

Komentet mund të përdoren gjithashtu për të parandaluar shpejt dhe me lehtësi ekzekutimin e kodit për qëllime testimi dhe korrigjimi. Kjo është referuar si komentimi i kodit.

Nëse ka një gabim në ndonjë kod që keni shkruar, komentimi i seksioneve do t'i parandalojë ata të ekzekutohen dhe mund të jetë i dobishëm në përcaktimin e burimit të problemit. Ju gjithashtu mund ta përdorni atë për të ndërruar kodin për të testuar rezultate të ndryshme.

// Function to add two numbers
function addTwoNumbers(x, y) {
  let sum = x + y;
  return sum;
}

// Function to multiply two numbers
function multiplyTwoNumbers(x, y) {
  let product = x * y;
  return product;
}

/* In this example, we're commenting out the addTwoNumbers
function, therefore preventing it from executing. Only the
multiplyTwoNumbers function will run */

// addTwoNumbers(3, 5);
multiplyTwoNumbers(5, 9);

Të dy komentet me një rresht dhe komentet e bllokut mund të përdoren për të komentuar kodin, në varësi të madhësisë së seksionit që ndërrohet.

Shënim: Komentimi i kodit duhet të bëhet vetëm gjatë qëllimeve të testimit. Mos lini copa të kodit të komentuar në skenarin tuaj përfundimtar.

Kur përpunoni logjikën e një programi, komentimi i kodit mund të jetë i dobishëm kur përcaktoni se ku janë gabimet ose vlerësoni linjat e kodit që ofrojnë më shumë dobi.

konkluzioni

Kodi JavaScript interpretohet nga kompjuteri, por gjithmonë do të lexohet nga programues të tjerë, duke përfshirë edhe veten tuaj të ardhshme. Marrja e kohës për të lënë shënimet e duhura në seksionet e ndërlikuara të kodit do të sjellë përfitime në të ardhmen, duke e bërë më të lehtë për ju dhe bashkëpunëtorët të kuptoni qëllimin e kodit që keni shkruar.