Aloittelija📝 Dokumentointi

Koodikommenttien lisääminen

Lisää selkeät kommentit monimutkaiseen koodiin.

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ää selkeät ja informatiiviset kommentit seuraavaan koodiin.

Koodi:
[KOODI]

Kommenttien tavoitteet:
- Selitä miksi, ei mitä
- Dokumentoi monimutkaiset osat
- Varoita sudenkuopista
- Lisää TODO:t tarvittaessa

Vältä itsestäänselvien asioiden kommentointia.

Suomenkieliset vinkit

Pyydä kommentit ja docstringit suomeksi jos projektisi on suomenkielinen
Voit pyytää AI:ta selittämään koodia suomeksi oppimista varten

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

[KOODI]

Esimerkki

Täytetty prompti

Lisää selkeät ja informatiiviset kommentit seuraavaan koodiin.

Koodi:
function debounce(fn, delay) {
  let timeoutId;
  return function (...args) {
    if (timeoutId) clearTimeout(timeoutId);
    timeoutId = setTimeout(() => {
      fn.apply(this, args);
      timeoutId = null;
    }, delay);
  };
}

Kommenttien tavoitteet:
- Selitä miksi, ei mitä
- Dokumentoi monimutkaiset osat
- Varoita sudenkuopista
- Lisää TODO:t tarvittaessa

Vältä itsestäänselvien asioiden kommentointia.