【UE4】BPをキレイにしよう：コメント編

この記事は、「ひとりUE4Advent Calendar 2017」の1日目の記事です。
qiita.com

はじめに

以前、このような記事を書きましたが、
dfkfuturelab.hatenablog.com
あれからかなり年月も経ち、自分なりにコメントの付け方も変わってきたので、
改めてBP整形の中の「コメント付け」について、もう少し触れた記事を作ろうと思いました。
特に技術的なすごい話をするわけではありません。
どっちかというと考え方的な話になるので、よろしくお願いします。

何のためにコメントをするのか

これは普通のC++やC#のコードでもあることですが、
自分一人しか見ることがなさそうなプロジェクトであってもコメントをするのはなぜなのか、と考える時、
私は2つの理由を考えました。

１：時と場合によっては自分以外が見ることになる可能性があるため
２：未来の自分が振り返りやすくするため

１はまさに、「L.F.O.」の移植において発生したことであり（ものすっごく恥ずかしかった）、
２はまさに、このブログを書いている時に発生しています。

例えばこのようなブループリントがあったとして（積極的に自分の古傷をえぐるスタイル）、

こんなことになっていては、例えこの画面の中で流用しやすく、他のプロジェクトでもぜひ使いたい処理があったとしても、
または新しい開発やバグの修正等で、把握しておきたい現行の処理があったとしても、
それを見つけることにすら一苦労することになるでしょう。

UE4のブループリントは、処理の流れを視覚的に見ることが出来ます。
一つのイベントの流れを１画面で見渡せるということは、コードで言うと数十行以上のものを１つの画面で表示できるということです。
ですから、上手にコメントをつけることで、コードにつけるコメント以上に見やすさや分かりやすさを向上することが出来ます。
例えば先程のBPの中で、

こうして一箇所コメントを入れるだけで、

全体図からでも、
1.「この位置にどんな処理をするイベントが置かれているか」がわかる
2.「プレイヤーのリファレンスを登録するイベントがどこにあるか」がわかる
この2つの、それぞれ違う目的における捜査について、大きな恩恵を得ることが出来ます。
これはつまり、「.cppのすべての行が1つの画面に表示される中で、どこで何が行われているのかがおおまかに理解できる」というようなものです。
何て素晴らしいんでしょう！！

整列とコメントの実践例

それでは、先程のBPを「左から右、上から下」の原則に基づいて整列します。

さて、この時点でも相当綺麗ですね？
しかしこれでは小さすぎて、どこで何が行われているのかがちっともわかりません。
なので、コメントを付けていきましょう。
コメントは、コメントを付けたいノードたちをドラッグで囲って、Cキーで配置できます。
今回は、このコメント欄の色分けをしてみましょう。

コメント欄は作ったときには白色ですが、

ここのComment Colorをいじることで色を変更できます（画像の場合は赤色になってます）

適当に色を振り分けるだけでもいいのですが、今回は更に、色の振り分けにルールをつけてみましょう。
これは自己流ですので、皆さんも自分流の色の振り分けを試してみてください。

まず最初にイベントの色分けです。このイベントは何をしている、というのが先程の「プレイヤーのリファレンスをセットする」などの単純なものであれば、
その変数やオブジェクトを示す色（アクタなら水色、floatなら緑色など）を割り振ります。
一言で言えない系、もしくは何をいじってるのかが単純じゃない系のイベントは真っ赤にしましょう。イベントノードの象徴色です。

さて、この作業をこなしてみた結果……

こうなりました。見やすい！！

この後は、お好みに合わせてイベント内の処理に対して、その処理が扱っている変数やオブジェクトを示す色を使って色分けします。
細かくしすぎるとかえって見づらくなるので、そこのバランスは何度もコメントを作って覚えていくと良いと思います。

最後に

たかがコメント、されどコメント。
こうやって一つ一つのコメントを作っていくことで、BPは見やすくなります。
それは他人にとっても、未来の自分にとっても、非常に有益なことだと思います。
いつか自分が作ったBPを見た人への、ささやかなおもてなし、思いやりの気持ちでコメントをつけると、
その結果はいつか自分にフィードバックされると思います。

以上でこの記事は終わりです。お疲れ様でした。

明日は私による「BPをキレイにしよう：折りたたみ編」です。