How to Generate Documentation & Comments For Source Code Automatically in VSCode IDE
0 views
Jul 5, 2025
Get the full source code of application here:
View Video Transcript
0:00
Uh hello guys, welcome to this video. So
0:02
in this video, I'll show you how to
0:03
generate documentation and comments
0:06
automatically for your source code
0:07
inside your VS code. So there is an
0:10
extension that you can install here. If
0:12
you just go to the extensions tab and
0:14
just type here documentation, the very
0:16
first extension which comes right, it's
0:18
a very popular extension which called as
0:21
deoxy de oxygen documentation gen
0:24
generator. It's used by almost 11
0:27
billion developers and it lets you
0:29
generate automatic documentation and
0:31
comment for your source code. So if you
0:34
have a source code file here after
0:36
activating this plug-in, it's very easy.
0:39
Simply go to the target file here. Let's
0:41
suppose this is my index C cpp file
0:45
here. So if you want to generate
0:47
comments for it, so you simply write
0:49
here / starst star and then press enter
0:54
and automatically all these uh
0:57
documentation will be generated which is
0:59
the actual file the author. Here you can
1:01
replace your author name, version, the
1:03
date, current date, copyright all these
1:06
things will be automatically inserted.
1:08
So you just need to write
1:11
/ star star and then press enter and
1:14
automatically this documentation will be
1:16
generated. So in this easy way you can
1:19
do this process again you can do this
1:23
if you have a certain kind of a
1:25
function. So it will generate this
1:27
documentation which is the parameter all
1:29
this stuff. So if you just want to
1:31
highlight some code slash star and
1:35
automatically that
1:38
it will document your code. It will
1:40
generate the appropriate documentation
1:42
and this comments of it like this. You
1:45
can target any language here. It can be
1:47
JavaScript, PHP as well. So if you have
1:51
this you can generate this comments
1:53
right here.
1:55
You can see that it's very easy.
1:59
So the extension name is de oxygenation
2:02
documentation generator. Simply activate
2:04
this and you can actually target any
2:06
source code file. It can be JavaScript
2:09
as well. So again you the syntax remains
2:12
the same / star
2:15
and then it will generate this
2:17
documentation
2:18
automatically.
2:20
So, thank you very much for watching
2:22
this video and also check out my website
2:25
freemediatools.com
2:26
uh which contains thousands of tools.
#Programming