Function comments #18

otevřený
otevřeno před 8 roky uživatelem pandro · 1 komentářů
pandro okomentoval před 8 roky
Spolupracovník

There should be basic doc strings for important, especially exported, functions.
Otherwise we might loose overview rather quickly.

Also the general idea of a file (e.g. 'what is in command.js') should be noted roughly.

There should be basic doc strings for important, especially exported, functions. Otherwise we might loose overview rather quickly. Also the general idea of a file (e.g. 'what is in command.js') should be noted roughly.
pandro přidal/a
Enhancement
štítek před 8 roky
lub okomentoval před 8 roky
Vlastník

Maybe it is worth to look into JSDoc? It is also used by matris-js-sdk.

You make your comments in the code (where they belong) including tags if needed and afterwards you can also build a documentation out of it, which provides probably a better overview than the comments in the code itself.

Also see http://usejsdoc.org/about-getting-started.html for examples

Maybe it is worth to look into [JSDoc](http://usejsdoc.org/)? It is also used by matris-js-sdk. You make your comments in the code (where they belong) including tags if needed and afterwards you can also build a documentation out of it, which provides probably a better overview than the comments in the code itself. Also see http://usejsdoc.org/about-getting-started.html for examples
Tento repozitář je archivovaný. Nemůžete komentovat úkoly.
Bez milníku
Bez zpracovatelů
2 účastníků
Termín dokončení
Termín dokončení není platný nebo je mimo rozsah. Použijte prosím formát „rrrr-mm-dd“.

Závislosti

Nejsou nastaveny žádné závislosti.

Reference: lubiland/heimdall#18
Načítá se…
Není zde žádný obsah.