Aloittelija📝 Dokumentointi

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio koodille.

Prompti

Lisää kattavat JSDoc-kommentit seuraavalle koodille.

Koodi:
[KOODI]

Dokumentoi:
- Funktion kuvaus
- Parametrit ja niiden tyypit
- Palautusarvo
- Esimerkkikäyttö
- Mahdolliset virheet

Käytä TypeScript-yhteensopivia JSDoc-tageja.

Suomenkieliset vinkit

Pyydä kommentit ja docstringit suomeksi jos projektisi on suomenkielinen
Suomenkielinen dokumentaatio on arvokasta suomalaisille tiimeille
Voit sekoittaa suomea ja englantia — teknisiä termejä ei tarvitse kääntää

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

[KOODI]

Esimerkki

Täytetty prompti

Lisää kattavat JSDoc-kommentit seuraavalle koodille.

Koodi:
async function fetchPaginatedData(endpoint, page, pageSize, filters) {
  const params = new URLSearchParams({
    page: page.toString(),
    pageSize: pageSize.toString(),
    ...filters
  });

  const response = await fetch(`${endpoint}?${params}`);
  if (!response.ok) throw new Error('Fetch failed');

  return response.json();
}

Dokumentoi:
- Funktion kuvaus
- Parametrit ja niiden tyypit
- Palautusarvo
- Esimerkkikäyttö
- Mahdolliset virheet

Käytä TypeScript-yhteensopivia JSDoc-tageja.