目次
概要
GDScriptのスクリプトドキュメンテーション機能は、「## <文字列>」 の形で記述したドキュメントコメントから、
エディタ上でのツールチップ表示やドキュメント生成を行う機能です。(Godot4.0から追加)
Godot Engine documentation
GDScript documentation comments
In GDScript, comments can be used to document your code and add descriptions to the members of a script. There are two differences between a normal comment and ...
使用方法
ドキュメントコメントは、各種スクリプトメンバー(変数/定数や関数、シグナルやクラスなど)に対して使用することができます。
変数のドキュメントコメント
最も基本的なドキュメントコメントの例として、以下に変数の説明の例を記載します。
@export var hp:int = 100 ## プレイヤーの現在のHPGodotエディタでこの変数の上にカーソルを合わせると、以下のように「プレイヤーの現在のHP」と表示されます。
関数のドキュメントコメントと改行
ドキュメントコメントでは、一部BBCodeのようなタグが使用できます。
以下は関数のドキュメントコメントで、[br]タグ を使用し、改行を行っています。
## 指定方向にキャラクターを移動する関数[br]
## 引数1 - direction 移動方向のベクトル[br]
## 引数２ - speed 移動速度（ピクセル/秒）[br]
## 戻り値 - 実際に移動した距離（Vector2）[br]
func move_character(direction: Vector2, speed: float) -> Vector2:
var delta = direction.normalized() * speed * get_process_delta_time()
return deltaこのように記述しておくと、関数補完時やマウスオーバー時に以下のような説明が表示されます。
※タグによる改行を行わない場合、以下のように一行で表示されます
クラスのドキュメントコメント
クラスのドキュメントコメントは、クラスの定義(class_name XXXX)を行った行の前後で以下のように記述できます。
extends Node
class_name TestClass
## <ここに概要を記述>
##
## <ここに説明を記述>
##F1から、定義したクラスのドキュメントを開くと、以下のように表示されます。
構成例
前述の例を１ファイルに構成した場合、自動で構成されるドキュメントの最終的な表示は以下のようになります。
コード
extends Node
class_name TestClass
## <ここに概要を記述>
##
## <ここに説明を記述>
##
@export var hp:int = 100 ## プレイヤーの現在のHP
## 指定方向にキャラクターを移動する関数[br]
## 引数1 - direction 移動方向のベクトル[br]
## 引数２ - speed 移動速度（ピクセル/秒）[br]
## 戻り値 - 実際に移動した距離（Vector2）[br]
func move_character(direction: Vector2, speed: float) -> Vector2:
var delta = direction.normalized() * speed * get_process_delta_time()
return delta
生成ドキュメント
リンク
リンク