DigitalPulseSoftware / BurgWar

Burg'war est un jeu de plateforme/combat multijoueur en 2D écrit en C++17/Lua avec mon propre moteur de jeu : Nazara Engine.
MIT License
52 stars 9 forks source link

[FEATURE] Documenter l'ensemble des fonctions et méthodes pour le scripting avec LuaDoc #51

Open SirMishaa opened 3 years ago

SirMishaa commented 3 years ago

Tu le sais déjà (vu que je viens de te le dire :kappa:) mais l'ajout de LuaDoc permet vraiment d'améliorer grandement l'autocomplétion et la compréhension de certaines méthodes.

L'idée est donc d'avoir une documentation générée avec LuaDoc, les IDE / éditeurs de code sont capable de lire cette documentation et de fournir de l'autocomplétion ainsi que de la prévention aux erreurs.

Voici un exemple, j'imagine que ça fonctionne aussi avec Visual Studio ;

luadoc