jsdoc on every public method - Githubissues

alesgenova / post-me

📩 Use web Workers and other Windows through a simple Promise API

https://www.npmjs.com/package/post-me

MIT License

492 stars 13 forks source link

jsdoc on every public method #28

Closed franleplant closed 3 years ago

franleplant commented 3 years ago

jsdoc is a great tool for providing inline documentation and combining it with typescript information, additionally with a tool such as typedoc (which is far far from perfect and far far from i.e. rust doc) we can generate automatic API documentation and even host it in github pages.

Additionally most modern IDE understand both typescript, type declarations and jsdoc comments so they will provide useful autocomplete information off of it.

document all public methods and interfaces
do not use jsdoc type annotations since we already have typescript
run some tests with typedoc

alesgenova commented 3 years ago

Yes, it sounds great to me! I don't have previous experience with jsdoc and typedoc, so you might be the better person to take a stab at it