-
-
Notifications
You must be signed in to change notification settings - Fork 494
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add JSDoc comments #582
Add JSDoc comments #582
Conversation
Yes, I assume that's welcome. I documented code in my contributions with JSDoc, too. |
Okay, since I got a positive comment + a 👍, I added docstrings to the rest of Would help if somebody could update the _tbd._s after a merge 😅 |
@zachleat Is there something blocking this from being merged? |
Signed-off-by: André Jaenisch <[email protected]>
Signed-off-by: André Jaenisch <[email protected]>
Signed-off-by: André Jaenisch <[email protected]>
Co-Authored-By: Peter Müller <[email protected]>
Thanks for this @Ryuno-Ki! |
Hi @zachleat,
just want to get your feedback on this before I invest too much time into it.
Would you accept JSDoc comments in your code?
This way, editors would be able to suggest Autocomplete, you could use them for typing with flow and you can render documentation for the implementation.
I can't speak for others, but I find it sometimes difficult to understand, what's going on.
Since I document my Node.js projects, I developed some opinions.
For example, using ink-docstrap for rendering more appealing JSDoc html files.
Read more about JSDoc online (old URL was usejsdoc).