Aloittelija📝 Dokumentointi

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio funktioille ja moduuleille niin, että IDE näyttää hyödylliset vihjeet. Kattaa parametrit, palautusarvot ja käyttöesimerkit.

Suora vastaus: mitä tämä sivu antaa?

Valmis promptimalli: voit kopioida sen sellaisenaan ja muokata muuttujat omaan tilanteeseen.
Nopea käyttöönotto: mukana on täytetty esimerkki ja selitys milloin promptia kannattaa käyttää.
Jos tarvitset työkalun käyttöohjeen: jatka Cursor-oppaisiin osoitteessa `/vibekoodaus/cursor`.

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.

Tulos

Täydelliset JSDoc-kommentit.

Vinkit

Näytä dokumentoitava koodi
Pyydä esimerkkikäyttö
Mainitse virhetilanteet

Milloin käyttää

Dokumentoit API:ta
Kirjaston julkaisu
Tiimin käyttöön

Liittyvät promptit

README-tiedoston luonti

Luo kattava README-tiedosto projektille.

Aloittelija

API-dokumentaation luonti

Luo kattava API-dokumentaatio, joka kattaa endpointit, parametrit, vastaukset ja esimerkit — niin että tiimin jäsenet ja ulkoiset kehittäjät pääsevät alkuun ilman lisäkysymyksiä.

Keskitaso

Koodikommenttien lisääminen

Lisää selkeät kommentit monimutkaiseen koodiin.