Posted at

[ #UE4 ]Blueprintの関数のピンに説明をつける

More than 1 year has passed since last update.

関数のBlueprintの入出力のピン(引数、戻り値)に対してコメント説明を付けられる隠し機能?について。


TL;DR


  • JavaDoc形式でDescription中に説明がかきこめる

  • 入出力ピンの説明はピンにホバーした時のTooltipに表示されるようになる

  • 多人数で開発する際にちゃんとドキュメント化しておくと迷わなくて便利なのでおすすめ


環境


  • UE4.16以降


    • 4.14ぐらいから機能自体は実装されているが、クラッシュするバグがある




入出力ピン説明付けられない問題

Blueprintの関数ノードそのものには説明がつけられる欄が用意されているが、入出力ピン(関数的に言えば引数や戻り値)には説明がつける欄が用意されていない。そのため、ピン数が多いノードはどのピンに何をどう繋げばよいのかわかりにくいという難点があった。

今回紹介する方法で説明を追加することで、きちんと入出力ピンに説明を追加し、しかもピンにホバーした時に表示することができるようになる。


説明追加方法

やりかたは関数BPの説明欄(Description)のテキスト中に、JavaDoc方式でコメントを書き込むことで実現可能。以下のタグが対応している。


@param

@param [ParamName] ...

func_param_doc.PNGfunc_output_pin_doc.PNG

入力ピン(引数)、および出力ピン(戻り値)の両方のピンに説明を追加することできる。

C系の関数と異なり、Blueprintの関数は複数の戻り値を出力ピンという形で返すことができるが、@paramタグも戻り値の説明ができることに注意。


@return/@returns

@return ...

func_return_doc.PNG

ReturnValueという名称の 出力ピンの説明を追加することができる。出力ピンの名称は 固定で複数説明できない ことに注意。


ノード自体への特別な説明追加方法

以下のタグはBPのノード自体への特別な説明表示ができるようになる。


@note/@see


description欄のサンプル

this is sample 

日本語ドキュメント

@note this is Note!
@see this is see!


func_note_see_doc.PNG


補足:説明欄(Description)内での改行

デフォルトでは1行文しかスペースがないが、Shift+Enterで改行することができる。

もっとも横幅が全角10文字ぐらいしかないのでテキストエディタ等で入力してコピペしたほうが容易かもしれない。


補足その2:BPマクロ

BPマクロは残念ながら非対応。この機能がつかえるのは内部的にUK2Node_CallFunctionを継承したノードのみ。