Auto Generate Documentation for Your Code in Godot 4
Вставка
- Опубліковано 7 січ 2024
- ▶︎ GODOT 4 COURSES : school.gdquest.com/godot-4-ea...
Early Access Starting Jan 30
🎓 FREE APP "Learn GDScript From Zero" : www.gdquest.com
🎮 Free Interactive Tour - The Godot Editor - www.gdquest.com/tutorial/godo...
🗨 GDQuest Discord Community : / discord
-------------------------------
🖈 MENTIONED LINKS
GITHUB CODE EXAMPLE : github.com/gdquest-demos/godo...
RELATED GODOT DOCS : docs.godotengine.org/en/stabl...
-------------------------------
🖋 SYNOPSIS
In this video, we demonstrate how to automatically generate Documentation for your code using Doc Strings and bbcode in GDScript starting Godot 4.
#godot #gamedev #gameengine
-------------------------------------------
CC-BY 4.0 LICENSE
Terms: creativecommons.org/licenses/...
Attribute To: "CC-By 4.0 - GDQuest and contributors - www.gdquest.com/"
So they added what I initially wanted to implement myself using a plugin? Nice
Your videos are so high-quality and easy to follow.
I would pretty much prefer if Godot rich label processor had a concept of a paragraph like in Markdown (empty line acting like a paragraph delimiter), instead of having people resort to the workaround like [br][br] double line breaks. But knowing how thorough the project is overall, I suspect they have a strong reason for leaving it as-is.
Autodocumentation FTW! ❤🎉
It's nice that everything improving slowly. I personally would want a refreshed menu creation tutorial with paralax, transitions, menu costumization, settings menu and a music controler all in one to make a game menu where settings can be reached. Later adding a game once I have more tutorials for how to make let's say strategy, adventure games for example. At moment I am just stuck with the amount of old and 5-6 months old relatively close tutorials and basically nothing works as intented. The only tutorial I managed to make was the first 3d game. I am not a coder myself so it's a bit harder for me now.
Did you try our free app to Learn GDScript? You can find it on gdquest.com. I highly recommend you invest some time picking up coding foundations to make it easier for you to navigate tutorials and get the point they're teaching regardless of how out of date they may be.
@@Gdquest I'll try my best. Thanks the reply.
This is VERY useful for those who DO like to document their code. I do....
It's truly an excellent habit
I have mixed feelings about that. It's good to have that, but it's bloat the code so much if noise, because of the choosen formating rules. Why not use markdown for example?
Thank you for sharing this! It's amazing to uncover all the "hidden gems" of Godot as you become familiar with it 💎
Thanks for this another short and useful video, It would be great to have some BBcode samples AND corresponding actual results, I know it's not such a brand new and unknown thing but the last part on commenting enum members is far to be self-explanatory about how it will look as documentation.
Also, I've mixed feelings cause it's still 10 years or more behind what text editing is and should be, having to create picture link manually without simple drag & drop is not that great. WYSIWYG editor is what we actually need in order to be productive and doing actual useful thing not messing around with text formatting.
godot is really pro-developer.
So I know you guys are focused on GDScript, but I couldn't find any documentation on this, is there a way to do doc strings in C#?
Is there a plugin to implement this in Godot 3? Great videos btw
I was looking at this video in hopes to have a C# equivalent. It doesn't seem to be the case at first glance.
Godot is the best...i always been an addict to games. With godot im close to release my first steam game 😊❤
Same here, good luck
Will you make a tutorial for your first 3d game like for the 2d one?
Yes! :)
@@Gdquest can't wait!
Can you include c# guides on same themes? Like in gdscript it look like:, then in c# it looks like:...
It would be wery helpfull!
At the moment we choose to teach GDScript partly because it lowers the barrier to entry for gamedevs who are new to coding, and partly because it's very adapted to game development and Godot. We have no current plans to teach C#. If that changes in the future, this channel is a good place to find out.
Is there a way to take the generated documents and upload it to say a GitHub wiki or similar?
You can export XML files.
You will need to further process them to display them nicely though. Here's how to do it:
Navigate to your project's directory. Then, create a directory to store the documents; I'll call it `docs`.
Then run:
```sh
godot --doctool ./docs --gdscript-docs res://
```
where `./docs` is the directory you just made and `res://` the project path you want to generate files for.
Your videos are excellent, thanks! Regarding this xml generation, I opened a bug because for me it's not working for a plugin I'm developing. I put the addons/name-of-plugin path as the value for the --gdscript-docs flag and plenty of errors appear and the xml are not generated. Have you ever tried generating them for a plugin?
Please make tutorial for how to make HotBar to change weapon
How to do this in C#?
I only learned of it recently and this video answered a lot of my questions about it. But is it just me or class scripts with @tool at the start won't show up in the Help window to generate documentation, leading to me not being able to link them in the documentation with [Class]?
It should work. I just tested it.
Eles tinham que por a documentação ofiline em PT Brasil 😢
É melhor habituares-te ao Inglês, porque outras linguas vão ser sempre de 2ª classe em software. Más traduções, traduções desatualizadas, terminologia inconsistente, dificuldade em pesquisar online, etc. etc..
Isto em tudo o que é software, não só Godot (tirando casos em que um projecto de software não usa Inglês como língua principal, e quando isso acontece praticamente nunca é Português)
Também aconselho aprender a usar teclado na disposição dos EUA ou parecida. Outras disposições tipo PT deixam caracteres essenciais à programação muito mais inacessíveis e vais passar a vida a contorcer as mãos.
Já agora, não é preciso comprar teclado novo para usar outra disposição, é só mudar uma definição no sistema.
Para aprender outra disposição podes colar papeis em cima das teclas que são diferentes ou ter uma folha com a disposição como referência.
Depois de aprender a disposição deixa de ser preciso, basta usar a memória. Também é bom aprender a escrever sem olhar para o teclado, e assim o que está escrito nas teclas deixa de ter importância. Vendem-se mesmo teclados sem nada escrito nas teclas, para quem escreve sem olhar (ou quer aprender.)
Eu recomendo pra caramba aprender inglês ao ponto de ficar confortável que nem vc é com port
A maioria das coisas úteis em questão de tutorial (e tudo) em inglês é mais abundante