wow, i had no idea what JSDoc was, and in 30 minutes i got the whole idea so clearly! thank you so much! your tutorial is so concise and on point. loved it!
Thanks a lot... Your channel has made me a better developer and has really improved my coding skills. Got motivated last month and I started my own web development UA-cam channel. Am grateful
Superb video. Watched it like 2-3 years ago and back for a refresher. The nice thing about jsdoc (in addition to dynamic documentation) is adding some sort of lightweight type checking for JavaScript which is some sort in the middle between JavaScript & typescript.
just stumbled over this in VS-Code by typing /** and auto complete, when i wanted to add a Description to a function. Thanks Brad 👍👍👍 Its a really cool Tool to use. Especially with the @ts-check! I wished i had seen this sooner. This video should have more clicks!
@@TraversyMedia You will reach 10M in no time Brad, you are one of the most Honest creators here and I really like to see your videos and Udemy courses. Keep coding and keep helping us :)
@@TraversyMedia Keep Doing Brad. You're doing an amazing job and help a lot of people around the world, thank you very much. Wish you 10 million subscribers and only the high-budget projects)
I feel like I have a hundred videos from your channel saved to watch later and keep procrastinating xD... You do the best choices on what to record about, even when it's not directly about tech. Sometimes answering something that I'm thinking about, sometimes about things I did not know i had to study but as soon as I see the video title I know it's something important. Also you have the best codealongs. Thanks man.
One of the great benefits of using JSDoc is to be able to use the `closure compiler`. As well as type definition and support auto-complete at code editor
@@TraversyMedia Heey Brad... Thank you very much for your endless contribution to the developer community...Lots of Love from Kenya...And eagerly awaiting for your VueJS series on the Node Master Class API....Thanks
One of starting points someone could take is this course, because it could allow any newbie to architect their codes from the beginning (of their career) especially since it cross-sections with typescript ideology
That readme option was dabomb! I hated that "Home" and wanted to change it, but I am using BetterDocs that is a template, so I couldn't use your approach since BetterDocs was already using the template, so at least I now have the Readme on that Home page. I'm glad I stayed to the last minute otherwise I would have missed it. :-)
AWESOME!! Thank you for this, I found this video because I wanted to implement JSDoc into my application but I'd never done it. I structured my code with verbose comments and source links, but perhaps the formatting and tags need to be corrected to work correctly with the JSDoc formatting. Anyway, I guess it's time to get busy refactoring all the comments. Watched the video through once, now I guess I'll have to work through it a few more times and actually follow along. :-D
Great video, for it's content and also the voice, totally fell asleep while listening to this on the train. May be it was the train ;) You should read bedtime stories :D
Hello Brad. I wish there was a video about how to read documentation of any programming language. What stuff to search in the documentation and where to find it? I find documentation very hard to understand. Love from Nepal :D
The greet method should return a string type, not a function like console.log... /** * @property {Function} greet A greeting with the name and age * @returns {string} A string with the name and age of a given person */ greet () { return `Hello, my name is ${this.name} and I am ${this.age}` }
Dude!!!! I swear to god I was thinking of this idea 3 days ago holy shit...they actually have it. I was thinking about having metadata as well like In c#
Grate tutorial and good speaker! I knew quite a bit already, but i wonder one thing... at 20:25 you use @property, I thought it was fine to just use @type, what is the different? Also i came here looking for tutorials on namepaths with JSDoc 3 and also more about importing with typedef, do you have any more tutorials on jsdoc? would want to see a part 2,3,4 and wants to learn every trick about jsdoc cuz i hate compilers. I'm particullary looking if it's possible to use namepaths in @params kinda like @params {sdk.namespace.User} user
Typescript has the more expressive type system. Eg, try generics with JSDOC. Also, TS code reads more like actual statically typed languages. With JSDOC, you need to look north for every definition. TS has JSDOC support too, for older arcane projects that cannot practically fully be typescriped.
Very cool introduction. I really like how VCode is checking the type when setting a wrong value (eg: reporting an error when assigning "a string" when the type is a number) @6:12. Do you know how I can enable such a feature for other IDE (do I need a plugin). I am using ESLint and VIM
could you please let me know, how should I set the configs in a way that the generated HTML files will be able to read the necessary files from a certain link and not the default address? tanx
Brad can you make tutorial "how to make appointment booking" if possible with google calendar? I found wordpress tutorials but is it possible to make without it? I'm trying to avoid wordpress if I can. Thank you legend :)
Struggling with getting methods to be documented relative to the instance type. Currently my methods show up listed on the same page as the module. I'd expect the instance type to have a page of its own, with methods listed there.
I'm so grateful for your videos man. Would you like to make a video converting from Context API to Redux? I'm trying to learn both of them right now and it would help me greatly.
Hi @Traversy Media Is it better to use this jsdoc versus the traditional "make your code document itself" programming? Like some companies don't like to do documentations as per them, that just means your code is dirty.
As someone in a position, where I need to maintain a programm (of just about 80MB) written by a predecessor at my place, I can say, that in my eyes you DEFINETLY NEED BOTH. If someone looks at your code without or with just little explainings, even the cleanest code will still raise many questions. Even having a jsDoc-documentation in many cases, it is still hard work to get behind the ideas of someone else.
I appreciate what JsDoc tries to achieve here and I sincerely appreciate the content, Brad. I'm ever grateful. However, I think JsDoc makes a codebase looks dirty or kinda unnecessarily long, heck unreadable to some extent. I believe the simple traditional docstring does the job well without making the code look more complex than it is.
Just minimize the comments if you don't like the look. The documentation + type checking is invaluable. JSDoc is pretty much TypeScript without the transpiling
Hi Brad you are outstanding I watch each and every video of your channel and also in udemy one request to you can you make videos on UI/UX design because I am not finding a good one please make for udemy as well as for UA-cam I watch your udemy course modern html CSS it was excellent learn a lot please reply if you can make video on UI/UX design thanks for your contribution
In VScode, The setting "javascript.implicitProjectConfig.checkJs": true is now deprecated in favor of the setting "js/ts.implicitProjectConfig.checkJs": true. Or simply at top of `index.js` add `// @ts-check` as Brad says
Two observations: 1) this seems to be more about vscode than jsdoc - how to use jsdoc without vscode? 2) fractions are not percentages...so 0.1 means 0.1% which is really low tax...you probably mean 10 and need to divide by 100 in the calculation; or call it a fraction/rate/something.
1:30 setup
4:40 type: variables( in global scope)
9:40 etc: custom template
11:30 type: function( in global scope)
14:30 type: custom type
18:40 type: variables & methods ( in Class)
24:30 type: Module
27:50 etc: tutorials
Incredibly helpful! Especially for someone who can't convince their boss that a Typescript conversion is worth the dev time
wow, i had no idea what JSDoc was, and in 30 minutes i got the whole idea so clearly! thank you so much! your tutorial is so concise and on point. loved it!
I'm intern and I need to create a software documention by the first time and your video just saved my life, Grateful from Brazil
One of the best documentation generation, even tho all look the same, this seems like the easier to get started with!
Your style of teaching is the best... no matter how hard the topic is, I always find it easy when you teach it... Love from India sir...
Brad, you're amazing. We need more people like you in this industry dominated by arrogants.
There are people out there trying to share real knowledge dude, but most of the times people don't even look around
Thanks a lot... Your channel has made me a better developer and has really improved my coding skills. Got motivated last month and I started my own web development UA-cam channel. Am grateful
Cool, I'll check it out
Thanks
Superb video. Watched it like 2-3 years ago and back for a refresher.
The nice thing about jsdoc (in addition to dynamic documentation) is adding some sort of lightweight type checking for JavaScript which is some sort in the middle between JavaScript & typescript.
just stumbled over this in VS-Code by typing /** and auto complete, when i wanted to add a Description to a function.
Thanks Brad 👍👍👍 Its a really cool Tool to use. Especially with the @ts-check! I wished i had seen this sooner.
This video should have more clicks!
Whenever I need something ASAP you just got it explained perfectly. You are the real MVP.
Waiting for 1 million subscribers 🔥
Me too :) It is amazing to me I even hit 100k, 1M is insane. I started this channel just to get a couple extra clients for my business
@@TraversyMedia You will reach 10M in no time Brad, you are one of the most Honest creators here and I really like to see your videos and Udemy courses. Keep coding and keep helping us :)
@@TraversyMedia Keep Doing Brad. You're doing an amazing job and help a lot of people around the world, thank you very much. Wish you 10 million subscribers and only the high-budget projects)
Billion*
@@TraversyMedia well well well.....
My coworker definitely needed this before I got hired...
😂😂😂😂😂😂😂
You are the best teacher ever.
JSDoc not only enforces code commenting but also gives good looking docs in return ❤️
Many thanks you for this short JSDoc tutorial.
Thanks Brad, keep making these tutorials :)
Perfect!! This is just what I needed! Thank you Brad
I feel like I have a hundred videos from your channel saved to watch later and keep procrastinating xD...
You do the best choices on what to record about, even when it's not directly about tech. Sometimes answering something that I'm thinking about, sometimes about things I did not know i had to study but as soon as I see the video title I know it's something important. Also you have the best codealongs.
Thanks man.
One of the great benefits of using JSDoc is to be able to use the `closure compiler`.
As well as type definition and support auto-complete at code editor
This is just pure gold! Thanks man
I watched Jest Crash Course and this JsDoc videos recently and they are very helpful
Brad Do a video on what to learn in 2020...Anyone with same idea like this comment
I will be doing my yearly guide soon
@@TraversyMedia that cool bro, also update us on the tec in cloud computing, serverless architecture....much on the line
@@TraversyMedia Heey Brad... Thank you very much for your endless contribution to the developer community...Lots of Love from Kenya...And eagerly awaiting for your VueJS series on the Node Master Class API....Thanks
Yes please. Will be waiting for it
@@calebmbugua745 Brathe Hadi Mimi niko Kenya.....'Hi from Kenya'
One of starting points someone could take is this course, because it could allow any newbie to architect their codes from the beginning (of their career) especially since it cross-sections with typescript ideology
Thanks, Brad for this video and for your help, we really appreciate that.
Hey Brad. congrats with 1M! you surely truely deserve it! =)
waiting for tutorial on swagger with node from you :D
That readme option was dabomb! I hated that "Home" and wanted to change it, but I am using BetterDocs that is a template, so I couldn't use your approach since BetterDocs was already using the template, so at least I now have the Readme on that Home page. I'm glad I stayed to the last minute otherwise I would have missed it. :-)
I bought your udemy course JavaScript and React and it's awesome.Thank You Brad.
@7:55, you can also say *number[]* instead of *Array*.
thank you very much bro ..
I just used your codes with gulp-jsdoc3 and
it is a very good feeling that it works at first try
I'm 100000% confident you'll hit 1 million before christmas.
AWESOME!! Thank you for this, I found this video because I wanted to implement JSDoc into my application but I'd never done it. I structured my code with verbose comments and source links, but perhaps the formatting and tags need to be corrected to work correctly with the JSDoc formatting. Anyway, I guess it's time to get busy refactoring all the comments. Watched the video through once, now I guess I'll have to work through it a few more times and actually follow along. :-D
Thank you so much for this incredible tutorial.
It really helped.
Wow, Awesome tool, great video Brad!!
I’m sold on using this in place of Typescript.
Berga, es que Traversy es el mejor codeando papá.
Great video, for it's content and also the voice, totally fell asleep while listening to this on the train. May be it was the train ;) You should read bedtime stories :D
Excellent video! So easy to follow. Thank you!!
Sir You are great i like your all videos it really helps me!!
Hello Brad. I wish there was a video about how to read documentation of any programming language. What stuff to search in the documentation and where to find it? I find documentation very hard to understand. Love from Nepal :D
Youre such a savage coder- than you for sharing!
23:00 `undefined` is the return type of greet method, if I am not wrong
The greet method should return a string type, not a function like console.log...
/**
* @property {Function} greet A greeting with the name and age
* @returns {string} A string with the name and age of a given person
*/
greet () {
return `Hello, my name is ${this.name} and I am ${this.age}`
}
You should be right. I was actually searching, if someone else has posted it .
Dude!!!! I swear to god I was thinking of this idea 3 days ago holy shit...they actually have it. I was thinking about having metadata as well like In c#
Wish did I see this video before... Awesome!
Grate tutorial and good speaker!
I knew quite a bit already, but i wonder one thing... at 20:25 you use @property, I thought it was fine to just use @type, what is the different? Also i came here looking for tutorials on namepaths with JSDoc 3 and also more about importing with typedef, do you have any more tutorials on jsdoc? would want to see a part 2,3,4 and wants to learn every trick about jsdoc cuz i hate compilers.
I'm particullary looking if it's possible to use namepaths in @params
kinda like @params {sdk.namespace.User} user
fantastic ....superb explanation bro .
would it be better to use JSDocs for type checking and enforcement or just use Typescript?
Typescript has the more expressive type system. Eg, try generics with JSDOC.
Also, TS code reads more like actual statically typed languages. With JSDOC, you need to look north for every definition.
TS has JSDOC support too, for older arcane projects that cannot practically fully be typescriped.
Very cool introduction. I really like how VCode is checking the type when setting a wrong value (eg: reporting an error when assigning "a string" when the type is a number) @6:12. Do you know how I can enable such a feature for other IDE (do I need a plugin). I am using ESLint and VIM
Incredible, thx for this video!
Types without build step, I'm in!
Brad love your tutorials.. can you make tutorial about swagger!
could you please let me know, how should I set the configs in a way that the generated HTML files will be able to read the necessary files from a certain link and not the default address? tanx
Another video post! Love this!
Thank you legend, Brad.
A great tool indeed!
Great tutorial!
Can it be used with Deno? If yes, how?
Great channel brad👍🏻
Always watching your videos.
This is just very nice thanks!
Please do you have a video on swagger with node typescript which was generator with express-generator
Hi there, can I ask if it is possible to read more than one md file?
It looks like the styles I'm changing in docs/styles/jsdoc-default.css are not sticking. Does anyone know how to make them stick?
If I need to include whole directory in jsdoc.json file... What Should I give instead of "include":[" src"] ???.
how his jsdoc comments are so colorful? which extension?
Good work!
pretty clear, thanks!
Love to watch your content
So I should write in TypeScript instead, right?
Does this only work with Node.js? Could it work with something like Laravel if you pointed to those files in the jsdoc.json config file?
great job!!!
What IDE are you using? Can we configue IDE for jsdoc?
Helpful. Cheers.
Brad i follow along your node express cc. i got problem installing bower even i tried in every computer
it reminds me of swagger. can you make tutorial about it too, please ? =)
Now in settings.json you have to write this string: "js/ts.implicitProjectConfig.checkJs": true
so so so excellent!
can anybody tell me is UA-cam api v3 is free?does it have quota restriction?
Brad can you make tutorial "how to make appointment booking" if possible with google calendar? I found wordpress tutorials but is it possible to make without it? I'm trying to avoid wordpress if I can. Thank you legend :)
Struggling with getting methods to be documented relative to the instance type. Currently my methods show up listed on the same page as the module. I'd expect the instance type to have a page of its own, with methods listed there.
Solved: needed to use `@method module:ModuleName.MyClass#methodName`. Found here: github.com/jsdoc/jsdoc/issues/1185
I'm so grateful for your videos man. Would you like to make a video converting from Context API to Redux? I'm trying to learn both of them right now and it would help me greatly.
Hi @Traversy Media
Is it better to use this jsdoc versus the traditional "make your code document itself" programming? Like some companies don't like to do documentations as per them, that just means your code is dirty.
As someone in a position, where I need to maintain a programm (of just about 80MB) written by a predecessor at my place, I can say, that in my eyes you DEFINETLY NEED BOTH. If someone looks at your code without or with just little explainings, even the cleanest code will still raise many questions. Even having a jsDoc-documentation in many cases, it is still hard work to get behind the ideas of someone else.
please make a video on how to use gmail api for sending messages from nodejs backend
How would you document a curried function?
IE:
const curriedFunction = param1 => param2 => {
return param1 + param2
}
I appreciate what JsDoc tries to achieve here and I sincerely appreciate the content, Brad. I'm ever grateful. However, I think JsDoc makes a codebase looks dirty or kinda unnecessarily long, heck unreadable to some extent. I believe the simple traditional docstring does the job well without making the code look more complex than it is.
Just minimize the comments if you don't like the look. The documentation + type checking is invaluable. JSDoc is pretty much TypeScript without the transpiling
I got "There are no input files to process" error. Not even after copy pasting your config. Please help somebody!!!
What about using Swagger?
Brad I want to hear your thoughts on Svelte, I've been wating for your crash course also.
how are you copying code i jsdoc.json file
Is there something like this for Python?
Hi Brad you are outstanding I watch each and every video of your channel and also in udemy one request to you can you make videos on UI/UX design because I am not finding a good one please make for udemy as well as for UA-cam I watch your udemy course modern html CSS it was excellent learn a lot please reply if you can make video on UI/UX design thanks for your contribution
very interesting thank you
In VScode, The setting "javascript.implicitProjectConfig.checkJs": true is now deprecated in favor of the setting "js/ts.implicitProjectConfig.checkJs": true. Or simply at top of `index.js` add `// @ts-check` as Brad says
Wah! This software is cool!
Sir kindly please do work on back-end development please
I would never knew what is the significance of
/**
*
*/
until i watched your video.
Two observations: 1) this seems to be more about vscode than jsdoc - how to use jsdoc without vscode? 2) fractions are not percentages...so 0.1 means 0.1% which is really low tax...you probably mean 10 and need to divide by 100 in the calculation; or call it a fraction/rate/something.
It is the best way to show my middle finger to typescript developer.
Please make tutorial on Swagger
Another option is to use jupyter notebooks with JS kernal.
Do video on how to read documentation for infant developers
Hii Bro ...Do an IONIC MOBILE APP ...USING ionic capacitor or cordova with angular frame work ...and deploy it in play store ...
I see 1million subscribers before the end 2019
awesome