【UE5】関数、変数に説明を追加する

変数

C++

変数の上の行にコメントを入れるとノードやアクターの詳細で表示されます。

// スコア
UPROPERTY(BlueprintReadWrite, EditAnywhere)
int32 Score;

　

もしくはメタ指定子の "Tooltip" で表示することも可能です。

UPROPERTY(BlueprintReadWrite, EditAnywhere, meta = (ToolTip = "スコア"))
int32 Score;

.

BP

変数の詳細から Description を設定することで表示できます。

C++ とは違い、Get/Setノードでは表示されませんが、BP上の変数リストでマウスを重ねると表示されます。
アクターの詳細にはC++同様に表示されます。

関数

C++

関数の上の行にコメントを入れるとノードにマウスを重ねた際に表示されます。

// テスト用関数
UFUNCTION(BlueprintCallable)
void MyFunc();

また、Doxygen的な書き方をすると引数にも説明を表示できます。

/*
* テスト用関数です。
* 
* @param Score 追加するスコア。
* @return スコア計算成功？
*/
UFUNCTION(BlueprintCallable)
bool CalcScore(int32 Score);

BP

BPで作った関数でも Description から説明を表示できます。
C++ とは記述方法は異なりますが、引数にも表示可能です。

UE Version : 5.0.0-19044958