Introduction
In this post I'll try to cover everything you need to know to get started with JSDoc. I'll also share with you some other c...
For further actions, you may consider blocking this person and/or reporting abuse
Thanks for your post! jsdoc is very useful, a helpful and often underrated solution to improve vanilla JavaScript development, especially in small, mostly HTML / CSS based projects without complex JavaScript stuff (and without Babel transpilation) whete you don't necessarily need Typescript.
Totally agree. Glad you enjoyed the post :)
Hi Paula ... nice intro to JSDoc!
You may be interested in this article (bit.ly/docJS) that describes how you can integrate a User's Guide (via GitBook) with your low-level API (using JSDoc).
You can see this in action in the docs of one of my open-source projects: feature-u.js.org/
Thank you Kevin! I've never tried GitBook, but sounds interesting. I'll definitely check out your article, looks like a great way to get the best of both worlds combined!
That swagger jsdoc integration seems interesting - I'm in the process of updating swagger doc file and it is rather inconvenient to do it "by hand" by checking the code every time.
Thanks for info on vs code, I'm trying to get off webstorm and that seems like a decent alternative.
Thanks for reading!
I loved the swagger integration too. It’s better than having to write the whole definition manually in separate files. But, to be honest, it’s still pretty tedious... So I'm still looking for better solutions. This one seems interesting too, but I haven't tried it yet.
I've been a huge fan of VSCode for years, its light and minimalist, but also highly customizable. You should definitely try it!
Found anything less tedious?
I found the JSDoc website a little ugly, but since JSDoc comment syntax is so widely used, I merged Vuepress and Documentation.js together. What I ended up doing is using the markdown docs from documentation.js and building them into a nice looking webpage with Vuepress. You can check it out here. However, I did have to write a small little script to add the metadata necessary for Vuepress to build it, however.
Hi Paula, exporting using jsdoc path/to/my/file.js was not working for me. On digging deep, I found that this works only if you have installed the jsdoc globally. however if you want to run it locally, you need to include the file location before the jsdoc command.
$ ./node_modules/jsdoc/jsdoc.js file.js
I hope it will help someone
You can even make TypeScript type check your JS files based on JSDoc comments: typescriptlang.org/docs/handbook/t...
Oh, nice one! Thank you
Thanks. documentation.js is a very convenient complement to JSDoc.
Seems interesting, thanks!
Markdown is supported in this style of comment I believe
You're absolutely right, thank you! I haven try it yet, but for anyone interested, here's the official doc about how to use markdown in JSDoc. Seems pretty straight forward.
Youre welcome, this is how to take your js doc comments to the next level. 😅
There is no config for vscode btw it just works.
Thank you for sharing this information, I already replicated in my node projects.
Great write up, thank you!
Thanks for reading!
As a QA engineer and frontend on my free time this is useful for both worlds 👍🏼
I'm glad!
This is great, thank you! We use jsdocs at work, so this was a great article on how we can use it better.
Glad I could help! JSDoc has been really useful, even when I'm working alone, it helps me realize if a function or method should be improved or refactored.
JSDoc is life. Today I realized I never used it by installing it on projects I worked on 😅 just followed the syntax and tags
So I'm not the only one who did that, awesome! 🤣
Easy to understand writeup. Thanks !!
Thanks for this - have wanted to get into inline documentation, but had not seen a nice intro (and the official docs are a bit... Dry).
I'm flattered :D once you start using JSDoc you won't be able to stop, trust me.
interesting, thanks