Générez la documentation technique de vos projets Godot

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines


Résumé

Découvrons comment utiliser GDScript Docs Maker pour générer automatiquement la documentation de vos projets Godot. Nous allons voir dans cet article que l’on peut simplement, à partir de notre code et de ses commentaires, avoir une documentation toujours à jour.


La documentation d’un projet est toujours une étape particulièrement délicate et rébarbative pour beaucoup de développeurs. De plus, le fait de la rédiger manuellement conduit mécaniquement à un risque grandissant, au fil des versions, d’une désynchronisation entre la documentation et le fonctionnement réel de cette application.

La solution, vous la connaissez, consiste à générer celle-ci à partir de vos sources. Ainsi au fil des évolutions, la documentation évoluera et restera toujours pertinente.

Pour ceux développant dans d’autres langages comme Java, PHP, etc., vous devez connaître javaDoc et phpDoc avec les outils associés pour générer cette documentation. Nous allons voir ici l’équivalent pour nos projets Godot.

Pour ceux utilisant un processus d’intégration continue (Gitlab CI / Jenkins, etc.), vous pouvez même inclure cette étape dans votre process pour automatiser la mise à jour de la documentation en continu.

Dans cet...

Cet article est réservé aux abonnés. Il vous reste 96% à découvrir.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

CrossDev sous Eclipse

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
112
Mois de parution
janvier 2021
Domaines
Résumé

Le développement logiciel nécessite l’utilisation d’outils pour l’écriture, la compilation et le débogage de code. La prise en main de ces outils n’est pas toujours évidente, alors lorsqu’on en maîtrise un, autant l’utiliser dans le maximum de cas. Eclipse permet cela et nous allons le voir dans le cas du développement embarqué.

L’édition des liens démystifiée

Magazine
Marque
GNU/Linux Magazine
Numéro
244
Mois de parution
janvier 2021
Domaines
Résumé

Parmi les étapes concourant à la fabrication d’un exécutable, l’édition des liens est certainement la plus méconnue. Elle est pourtant cruciale à plus d’un titre. Le choix entre édition statique et dynamique des liens a notamment des implications sur la facilité de développement, la sécurité et la performance.