Como documentar código en Godot

Porque mantener el código organizado y legible para otros es importante

La llegada de Godot 4.0 tiene a mas de una persona desarrollando la increíble habilidad de la paciencia. El que hayan añadido anotaciones hizo que mas de uno pensara que seria buena idea exponer la forma en que Godot genera la documentación (algo increíblemente útil para los creadores de módulos y plugin).

Hasta que la documentación oficial sea actualizada, anotaré aquí la forma de documentar que se ha visto añadida en Godot

extends Script
class_name ClasePersonalizada

##
## Pequeña descripción de la clase
##
## @desc:
##    Descripción larga de la clase
##
## @tutorial(Titulo del enlace): <enlace>
##  

## Descripción de la variable
var una_variable

## Descripción de la función
func una_funcion() -> void:
    pass

Hilos relacionados

Enable scripts to generate XML API documentation for the editor's GUI · Issue #177 · godotengine/godot-proposalsGitHub

Documentation generation for GDScript · Issue #993 · godotengine/godot-proposalsGitHub

Add GDScript support for defining virtual/prototype/must-override methods in base classes · Issue #1631 · godotengine/godot-proposalsGitHub