Comentaris

Posar comentaris en JavaScript és essencial per documentar el codi i fer-lo més comprensible per a tu i altres desenvolupadors. Hi ha dues maneres principals de fer-ho: per a línies úniques i per a blocs de text.

1. Comentaris d'una sola línia (Single-line comments)

S'utilitzen per comentar una línia de codi o una part d'una línia. El text que segueix el símbol és ignorat pel motor de JavaScript fins al final de la línia.

Sintaxi

S'utilitzen dues barres inclinades cap endavant (//):

// Aquesta funció calcula el doble d'un nombre
function doble(x) {
  return x * 2; // Retornem el resultat de la multiplicació
}

2. Comentaris de multilínia (Multi-line comments)

S'utilitzen per escriure comentaris llargs que ocupen diverses línies, o per comentar temporalment un bloc sencer de codi.

Sintaxi

Comencen amb barra inclinada i asterisc (/*) i acaben amb asterisc i barra inclinada (*/):

/*
Aquest bloc de codi s'encarrega
de la inicialització de l'aplicació.
Inclou la configuració de variables globals
i la càrrega de dades inicials.
*/

function iniciarApp() {
  /*
  // Comentar temporalment un bloc de codi existent
  // let dades = carregarDades();
  // processarDades(dades); 
  */
  console.log("Aplicació iniciada.");
}

3. JSDoc (Comentaris de Documentació)

Encara que tècnicament són comentaris de múltiples línies, tenen un propòsit especial. JSDoc és un sistema d'etiquetes que s'utilitza per documentar funcions, classes i mètodes d'una manera estandarditzada. Moltes eines, com editors de codi (VS Code) o generadors de documentació, poden llegir aquests comentaris per oferir ajuda contextual o crear documentació automàtica.

Sintaxi

Comencen amb barra inclinada i doble asterisc (/**):

/**
 * Suma dos nombres i retorna el resultat.
 * @param {number} a - El primer nombre a sumar.
 * @param {number} b - El segon nombre a sumar.
 * @returns {number} La suma total de 'a' i 'b'.
 */
function sumar(a, b) {
  return a + b;
}