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...
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première
