Documenting Your JavaScript | JSDoc Crash Course

  Рет қаралды 130,279

Traversy Media

Traversy Media

Күн бұрын

In this video I will go over JSDoc for documenting your JavaScript code as well as using it for type checking
Sponsor: Linode Cloud Hosting
Get $20 Free by visiting www.linode.com/traversy
Code:
github.com/bradtraversy/jsdoc...
💖 Become a Patron: Show support & get perks!
/ traversymedia
Website & Udemy Course Links:
www.traversymedia.com
Follow Traversy Media:
/ traversymedia
/ traversymedia
/ traversymedia

Пікірлер: 149
@madebylewis
@madebylewis 4 жыл бұрын
Incredibly helpful! Especially for someone who can't convince their boss that a Typescript conversion is worth the dev time
@ProgrammingwithPeter
@ProgrammingwithPeter 4 жыл бұрын
One of the best documentation generation, even tho all look the same, this seems like the easier to get started with!
@Naochadporumtriz
@Naochadporumtriz 4 жыл бұрын
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
@dawidgaleziewski3335
@dawidgaleziewski3335 4 жыл бұрын
Whenever I need something ASAP you just got it explained perfectly. You are the real MVP.
@khalidelgazzar
@khalidelgazzar Жыл бұрын
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.
@user-38e9f4e7cu
@user-38e9f4e7cu Жыл бұрын
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!
@ritwikmath7937
@ritwikmath7937 4 жыл бұрын
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...
@user-zb8wr9ir2w
@user-zb8wr9ir2w Жыл бұрын
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
@ferdindev4019
@ferdindev4019 4 жыл бұрын
Thanks, Brad for this video and for your help, we really appreciate that.
@gracechoi257
@gracechoi257 4 жыл бұрын
Perfect!! This is just what I needed! Thank you Brad
@TheVertical92
@TheVertical92 3 жыл бұрын
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!
@muhammedozalp
@muhammedozalp 4 жыл бұрын
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
@SethEden
@SethEden 4 жыл бұрын
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
@sidneykantor
@sidneykantor 2 жыл бұрын
Excellent video! So easy to follow. Thank you!!
@rishabh7g
@rishabh7g 3 жыл бұрын
Thanks Brad, keep making these tutorials :)
@cleancodez
@cleancodez 4 жыл бұрын
Brad Do a video on what to learn in 2020...Anyone with same idea like this comment
@TraversyMedia
@TraversyMedia 4 жыл бұрын
I will be doing my yearly guide soon
@cleancodez
@cleancodez 4 жыл бұрын
@@TraversyMedia that cool bro, also update us on the tec in cloud computing, serverless architecture....much on the line
@calebmbugua745
@calebmbugua745 4 жыл бұрын
@@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
@BilalBaloch-tl2bp
@BilalBaloch-tl2bp 4 жыл бұрын
Yes please. Will be waiting for it
@cleancodez
@cleancodez 4 жыл бұрын
@@calebmbugua745 Brathe Hadi Mimi niko Kenya.....'Hi from Kenya'
@rutvikshah4589
@rutvikshah4589 4 жыл бұрын
Waiting for 1 million subscribers 🔥
@TraversyMedia
@TraversyMedia 4 жыл бұрын
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
@vaibhavnadgonde4397
@vaibhavnadgonde4397 4 жыл бұрын
@@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 :)
@o.voytyn
@o.voytyn 4 жыл бұрын
@@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)
@balsamirkovic7051
@balsamirkovic7051 4 жыл бұрын
Billion*
@cthulhulalala7182
@cthulhulalala7182 3 жыл бұрын
@@TraversyMedia well well well.....
@dusanaleksic4680
@dusanaleksic4680 4 жыл бұрын
I bought your udemy course JavaScript and React and it's awesome.Thank You Brad.
@AnatolyKosorukov
@AnatolyKosorukov 2 жыл бұрын
Many thanks you for this short JSDoc tutorial.
@Chandasouk
@Chandasouk 4 жыл бұрын
My coworker definitely needed this before I got hired...
@deola9862
@deola9862 2 жыл бұрын
😂😂😂😂😂😂😂
@bibalavida
@bibalavida 2 жыл бұрын
This is just pure gold! Thanks man
@canerdemircigm
@canerdemircigm Жыл бұрын
I watched Jest Crash Course and this JsDoc videos recently and they are very helpful
@mukst1o
@mukst1o 4 жыл бұрын
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.
@antonioquintero-felizzola5334
@antonioquintero-felizzola5334 4 жыл бұрын
Brad, you're amazing. We need more people like you in this industry dominated by arrogants.
@aldocaamal7740
@aldocaamal7740 4 жыл бұрын
There are people out there trying to share real knowledge dude, but most of the times people don't even look around
@tannercampbell
@tannercampbell 4 жыл бұрын
Wow, Awesome tool, great video Brad!!
@princechaudhary3382
@princechaudhary3382 4 жыл бұрын
Sir You are great i like your all videos it really helps me!!
@ridl27
@ridl27 4 жыл бұрын
Hey Brad. congrats with 1M! you surely truely deserve it! =) waiting for tutorial on swagger with node from you :D
@tahasoft1
@tahasoft1 4 жыл бұрын
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
@igorgoncalves5691
@igorgoncalves5691 Жыл бұрын
Incredible, thx for this video!
@haciendadad
@haciendadad 3 жыл бұрын
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. :-)
@rivosuoth
@rivosuoth 3 жыл бұрын
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
@austinskylines
@austinskylines 4 жыл бұрын
Youre such a savage coder- than you for sharing!
@pasteros
@pasteros 4 жыл бұрын
Another video post! Love this!
@scodemy1976
@scodemy1976 4 жыл бұрын
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 KZfaq channel. Am grateful
@cruise_ng
@cruise_ng 4 жыл бұрын
Cool, I'll check it out
@scodemy1976
@scodemy1976 4 жыл бұрын
Thanks
@pawebanas9837
@pawebanas9837 3 жыл бұрын
You are the best teacher ever.
@prateekgupta1417
@prateekgupta1417 3 жыл бұрын
JSDoc not only enforces code commenting but also gives good looking docs in return ❤️
@abdifatahmoh
@abdifatahmoh 4 жыл бұрын
Thank you legend, Brad.
@ems_
@ems_ 4 жыл бұрын
A great tool indeed! Great tutorial! Can it be used with Deno? If yes, how? Great channel brad👍🏻 Always watching your videos.
@jaiharshagottumukkala6538
@jaiharshagottumukkala6538 4 жыл бұрын
fantastic ....superb explanation bro .
@BlissAden
@BlissAden 2 жыл бұрын
This is just very nice thanks!
@Cognitoman
@Cognitoman 4 жыл бұрын
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#
@fagnersales532
@fagnersales532 3 жыл бұрын
Wish did I see this video before... Awesome!
@juanvieira8249
@juanvieira8249 4 жыл бұрын
pretty clear, thanks!
@kursionable
@kursionable 3 жыл бұрын
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
@YousefSh
@YousefSh 4 жыл бұрын
@7:55, you can also say *number[]* instead of *Array*.
@rohitsancheti96
@rohitsancheti96 4 жыл бұрын
Brad love your tutorials.. can you make tutorial about swagger!
@neerajdahal8215
@neerajdahal8215 4 жыл бұрын
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
@danielk09
@danielk09 4 жыл бұрын
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.
@bryankey7421
@bryankey7421 4 жыл бұрын
Berga, es que Traversy es el mejor codeando papá.
@BruX013
@BruX013 2 жыл бұрын
Helpful. Cheers.
@martinp7841
@martinp7841 Жыл бұрын
I’m sold on using this in place of Typescript.
@itahirk
@itahirk 4 жыл бұрын
I'm 100000% confident you'll hit 1 million before christmas.
@justinphilpott
@justinphilpott 3 жыл бұрын
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
@bamokinamoandadestin7888
@bamokinamoandadestin7888 Жыл бұрын
great job!!!
@vuyyururajashekarreddy493
@vuyyururajashekarreddy493 4 жыл бұрын
Love to watch your content
@virginielemaire6502
@virginielemaire6502 2 жыл бұрын
very interesting thank you
@simonx3088
@simonx3088 4 жыл бұрын
so so so excellent!
3 жыл бұрын
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
@fernbe
@fernbe 3 жыл бұрын
Good work!
@HeyDan1983
@HeyDan1983 4 жыл бұрын
Brad I want to hear your thoughts on Svelte, I've been wating for your crash course also.
@nobodyeverybody8437
@nobodyeverybody8437 Жыл бұрын
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
@tannercampbell
@tannercampbell 4 жыл бұрын
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?
@chnsonic
@chnsonic 4 жыл бұрын
Wah! This software is cool!
@abhaykumarjha5160
@abhaykumarjha5160 4 жыл бұрын
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 KZfaq 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
@tjfaith1535
@tjfaith1535 Жыл бұрын
Please do you have a video on swagger with node typescript which was generator with express-generator
@SachiGuftagu
@SachiGuftagu 3 жыл бұрын
Great !
@konnorrogers7524
@konnorrogers7524 4 жыл бұрын
How would you document a curried function? IE: const curriedFunction = param1 => param2 => { return param1 + param2 }
@AhmedIbrahim-wx8sm
@AhmedIbrahim-wx8sm 3 жыл бұрын
hi mr brad ,you document single file what if i want to document another file in the same project ?
@timothygoh8237
@timothygoh8237 4 жыл бұрын
Hi there, can I ask if it is possible to read more than one md file?
@ridl27
@ridl27 4 жыл бұрын
it reminds me of swagger. can you make tutorial about it too, please ? =)
@TheKennyWorld
@TheKennyWorld 7 ай бұрын
Types without build step, I'm in!
@krstas03
@krstas03 4 жыл бұрын
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 :)
@andig97
@andig97 4 жыл бұрын
awesome
@santhosh8495
@santhosh8495 2 жыл бұрын
If I need to include whole directory in jsdoc.json file... What Should I give instead of "include":[" src"] ???.
@notgamer2095
@notgamer2095 4 жыл бұрын
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.
@noideaofhowcallme
@noideaofhowcallme 3 жыл бұрын
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.
@JimKernix
@JimKernix 7 ай бұрын
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?
@aruljothysundaramoorthy9446
@aruljothysundaramoorthy9446 2 жыл бұрын
awesome :)
@jeniferfuentes4484
@jeniferfuentes4484 4 жыл бұрын
Brad i follow along your node express cc. i got problem installing bower even i tried in every computer
@snapblast1782
@snapblast1782 4 жыл бұрын
What IDE are you using? Can we configue IDE for jsdoc?
@mikeonthebox
@mikeonthebox Жыл бұрын
At 22:44 Person took age as a number, but the property was defined as string. I guess this is because the "Object" that the constructor takes was not specified in any way. Right?
@victorklimov5254
@victorklimov5254 3 жыл бұрын
Now in settings.json you have to write this string: "js/ts.implicitProjectConfig.checkJs": true
@babyboie20
@babyboie20 4 жыл бұрын
would it be better to use JSDocs for type checking and enforcement or just use Typescript?
@arpanagarwal2524
@arpanagarwal2524 3 ай бұрын
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.
@gudiputisairam346
@gudiputisairam346 4 жыл бұрын
Sir kindly please do work on back-end development please
@irsathkareem7513
@irsathkareem7513 4 жыл бұрын
please make a video on how to use gmail api for sending messages from nodejs backend
@Krishnasaini
@Krishnasaini Жыл бұрын
how his jsdoc comments are so colorful? which extension?
@AnkurMishra1990
@AnkurMishra1990 4 жыл бұрын
23:00 `undefined` is the return type of greet method, if I am not wrong
@drozerahwebdev2845
@drozerahwebdev2845 4 жыл бұрын
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}` }
@noideaofhowcallme
@noideaofhowcallme 3 жыл бұрын
You should be right. I was actually searching, if someone else has posted it .
@anishgupta7463
@anishgupta7463 3 жыл бұрын
It is the best way to show my middle finger to typescript developer.
@shashankmorekar2559
@shashankmorekar2559 4 жыл бұрын
can anybody tell me is KZfaq api v3 is free?does it have quota restriction?
@TAKcomps
@TAKcomps 4 жыл бұрын
So I should write in TypeScript instead, right?
@olol6284
@olol6284 4 жыл бұрын
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.
@YunisRajab
@YunisRajab 3 жыл бұрын
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
@rajeshkab
@rajeshkab 4 жыл бұрын
Is there something like this for Python?
@deepanshusingh2352
@deepanshusingh2352 3 жыл бұрын
I would never knew what is the significance of /** * */ until i watched your video.
@ezeamaka
@ezeamaka 4 жыл бұрын
I see 1million subscribers before the end 2019
@harshamv5113
@harshamv5113 4 жыл бұрын
What about using Swagger?
@flippantfishtaco3132
@flippantfishtaco3132 4 жыл бұрын
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.
@flippantfishtaco3132
@flippantfishtaco3132 4 жыл бұрын
Solved: needed to use `@method module:ModuleName.MyClass#methodName`. Found here: github.com/jsdoc/jsdoc/issues/1185
@jaiharshagottumukkala6538
@jaiharshagottumukkala6538 4 жыл бұрын
Hii Bro ...Do an IONIC MOBILE APP ...USING ionic capacitor or cordova with angular frame work ...and deploy it in play store ...
@tastaslim
@tastaslim 3 жыл бұрын
how are you copying code i jsdoc.json file
@satyam8439
@satyam8439 4 жыл бұрын
🤩🤩🤩
@RahulYadav-nk6wp
@RahulYadav-nk6wp 4 жыл бұрын
Another option is to use jupyter notebooks with JS kernal.
@IamMclov1n25
@IamMclov1n25 4 жыл бұрын
can you make more algo videos? please and thanks!
PHP For Absolute Beginners | 6.5 Hour Course
6:27:22
Traversy Media
Рет қаралды 671 М.
HTMX Crash Course | Dynamic Pages Without Writing Any JavaScript
56:47
Traversy Media
Рет қаралды 134 М.
Smart Sigma Kid #funny #sigma #comedy
00:19
CRAZY GREAPA
Рет қаралды 13 МЛН
Would you like a delicious big mooncake? #shorts#Mooncake #China #Chinesefood
00:30
Они убрались очень быстро!
00:40
Аришнев
Рет қаралды 3,3 МЛН
Async JS Crash Course - Callbacks, Promises, Async Await
24:31
Traversy Media
Рет қаралды 1,4 МЛН
Beginner's Guide to the Bash Terminal
1:14:37
Joe Collins
Рет қаралды 2,3 МЛН
Vite Crash Course | Faster Alternative To CRA
16:24
Traversy Media
Рет қаралды 186 М.
The Programming Language Guide
24:25
Traversy Media
Рет қаралды 445 М.
Git MERGE vs REBASE
16:12
Academind
Рет қаралды 1 МЛН
How to Do 90% of What Plugins Do (With Just Vim)
1:14:03
thoughtbot
Рет қаралды 868 М.
How to use JSDoc - Basics & Introduction
13:05
dcode
Рет қаралды 46 М.
Programming's Greatest Mistakes • Mark Rendle • GOTO 2023
51:24
GOTO Conferences
Рет қаралды 80 М.
ВЫ ЧЕ СДЕЛАЛИ С iOS 18?
22:40
Overtake lab
Рет қаралды 128 М.
Дени против умной колонки😁
0:40
Deni & Mani
Рет қаралды 12 МЛН
Девушка и AirPods Max 😳
0:59
ОТЛИЧНИКИ
Рет қаралды 17 М.
Samsung Galaxy 🔥 #shorts  #trending #youtubeshorts  #shortvideo ujjawal4u
0:10
Ujjawal4u. 120k Views . 4 hours ago
Рет қаралды 1,7 МЛН