無料・軽快な 2D / 3D 用のゲームエンジン Godot Engine 4 の GD スクリプトに定義した自作の関数や変数に ## から始まるドキュメンテーションコメントを記述して、リファレンスドキュメントでクラスや関数について説明文を追加表示する手順を紹介します。
リファレンスドキュメントの開き方についても紹介します。
※ GodotEngine 4.3 を使用しています。.NET 版ではありません。
※スクリプトは自己責任でご使用ください。
クラスや関数にドキュメンテーションコメントを追記
リファレンスドキュメントには、クラス名や継承元、メソッドの一覧などが表示されますが、ドキュメンテーションコメントを書くことで、説明文を追加することができます。
※スクリプトを編集する場合は Script ワークスペースを選択して、左側のリストからスクリプトファイルを選択してください。
ドキュメンテーションコメントを追加するには、class_name の後や、関数の前に ## から始まる文章を書きます。
extends Object
class_name SakuraCrowdUtil
## SakuraCrowd が作成したユーティリティ関数群です。
## object の持つプロパティの名前と値の文字列を１行ずつ出力します。
## 形式については get_all_property_name_and_value 関数を参照してください。
static func print_all_property_name_and_value(object: Object) -> void:
# object のプロパティ１つずつを文字列として格納した配列を取得します。
var string_array: Array[String] = get_all_property_name_and_value(object)
# プロパティの文字列を１行ずつ（プラパティ１つずつ）出力します。
for string in string_array:
print(string)
returnドキュメンテーションコメントの詳細については公式サイト「GDScript documentation comments — Godot Engine (stable) documentation in English」等を参照してください。
※ BB コードを使って太字などの文字修飾もできるようです。
リファレンスドキュメントを開いて確認する
リファレンスドキュメントを開くには、メニュー「ヘルプ」→「ヘルプを検索」を選択します。
リファレンスドキュメントはクラスごとに開くことができます。
既存のクラスの他に、class_name で名前付きクラスに登録した自作のクラスのリファレンスドキュメントも開くことができます。
「ヘルプを検索」ダイアログで、さきほどドキュメンテーションコメントを追加したクラスを選択して「開く」ボタンを押しましょう。
※上部の検索ボックスを使うと探しやすいです。
テスト
選択したクラスのリファレンスドキュメントが Script ワークスペースで開かれました。
※左側のリストにも追加され DOC というアイコンがついています。
先ほど記述したクラスの説明文も表示されました。
ドキュメンテーションコメントを書いていない関数についてもリストに列挙されています。
ドキュメンテーションコメントで説明文を書いた関数については、その説明文も記載されています。
まとめ
今回は、無料・軽快な 2D / 3D 用のゲームエンジン Godot Engine 4 の GD スクリプトに定義した自作の関数や変数に ## から始まるドキュメンテーションコメントを記述して、リファレンスドキュメントでクラスや関数について説明文を追加表示する手順を紹介しました。
リファレンスドキュメントの開き方についても紹介しました。
参照サイト Thank You!
- Godot Engine – Free and open source 2D and 3D game engine
- GDScript documentation comments — Godot Engine (stable) documentation in English
- Auto Generate Documentation for Your Code in Godot 4 – YouTube
記事一覧 → Compota-Soft-Press
コメント