Godot 4 Comentarios en GDScript

En este tutorial aprenderemos que es un comentario y cómo utilizarlos en GDScript con Godot 4, además veremos como usar los comentarios para documentación en Godot Engine.

¿Qué Es Un Comentario En Programación?

Un comentario en programación es una línea de texto o bloque de texto que se inserta en un código de programación con el propósito de proporcionar información o documentación adicional al código fuente. 
Los comentarios no son ejecutados como parte del programa y se utilizan para añadir información para quien lee el código o para excluir ciertas líneas de código de la ejecución.

¿Cómo Se Crean Comentarios En GDScript?

La forma más simple de crear comentarios en Godot es usando el símbolo conocido como hashtag, almohadilla, o gato ( # )

# Este es un comentario

Comentarios Multilínea En Godot

Para crear comentarios de múltiples líneas debemos usar Comillas Triples

func _ready():
	'''
	Comentario
	de multiples
	lineas
	'''

	"""
	Comentario 
	de multiples 
	lineas
	"""

ERROR: Unexpected «Literal» In Class Body.

Los comentarios multilínea solo se puede usar dentro de un bloque de código, como por ejemplo las funciones, o te aparecerá el siguiente error:

Unexpected «Literal» in class body.

Shortcut Para Documentar Múltiples Líneas

Puedes comentar y descomentar múltiples líneas seleccionando el código y presionando las teclas ctrl k

Comentarios Para Documentación En Godot (Doc Comments)

Este tipo de comentarios son muy útiles si vas a subir tu código a GitHub, ya que puedes agregar información adicional.

Y también te pueden servir para agregar información adicional al editor de código.

Se crean usando doble hashtag seguido de la descripción del código.

## Code here

extends Node2D
## A brief description of your script.
##
## A more detailed description of the script.
##
## @tutorial:            http://the/tutorial1/url.com
## @tutorial(Tutorial2): http://the/tutorial2/url.co

Como podemos ver en estos ejemplos puedes agregar enlaces a tu sitio web

Aquí tienes el link de los comentarios de documentación en Godot este tipo de comentarios se les conoce como Docs Comments, por eso se encuentran en la sección documentation comments.

Video sobre Godot 4 Comentarios en GDScript

Este video es parte del curso de GDScript para Godot 4 y resolverá varias de tus dudas sobre como utilizar los comentarios en Godot Engine.