コメント機能の意義

あれっ？数日ぶりにフレーム再生してみたら思った挙動と違う…

どれ、イベント内容の確認でもしてみるか…

　　　　　　　　　　↓

やだ…私計画性無さ過ぎ!?

どの行で何を処理しているのか分からない…

どの変数で何が変わるのか分からない…

　　　　　　　　　　↓

もういい、やめぽ。寝よう

ハイ、私の事です。

結構あると思うんですが、一度自分で組んだはずのイベントが、数日経って見返すと、もうわけが分からない…

誰かが「1週間経つと他人のコード」と仰いましたが正にそのとおりだと思います。

というわけで、今日はインディゲームクリエーター（CF2.5）での『イベントの可読性』を高める方法の考察です。

■最も可読性が高くなるイベントエディタは？

CF2.5にはフレーム、オブジェクト、グローバルの3つのイベント入力エディタが備わっていますが、内最も可読性（後からイベントを読み返した時に、どこで何をしているかの分かりやすさ）が高くなるのはどこか？

それは間違いなくフレームエディタだと思います。

何故なら、

イベントリストエディタで表示出来るから

です。

画像のように、イベント条件に対するアクションが一覧で表示される為、どこで何を処理しているのかがリスト状で表示される為一目で分かり、かつイベント順の入れ替えも容易です。

ですが、この機能は残念ながらフレームイベントにしか適用出来ない為、オブジェクト、或いはグローバルイベントに組んだイベントをリスト化する事が出来ません。

じゃあそっちに組んだイベントはどうやったらいいのか、という事ですが、これには二つやり方があると思います。

①最初からフレームイベントで設計して、後からグローバル、オブジェクトイベントに移行してやる

②デバッグ用のフレームを用意して、フレームイベントにコピペしてリスト化する

私の場合は、デバッグ兼新規オブジェクト開発用のアプリケーションを別に用意して、そこのフレームイベントで先ず作成、9割完成してから本体のグローバル、又はオブジェクトイベントに戻して調整しています。

■コメント機能をフル活用しよう 

上の画像は私が現在開発しているゲームのイベント画面です。

他人に見せる為に作っているのか？と言わんばかりにコメントを打っております。

イベントを組んでいる時は今自分が何の動作を処理しているのか認識しているので、こんな作業はバカらしいと思いますが、数日後に見返すと本当に他人が作った物かのように何をしているのか分からなくなります。

しつこいくらいにコメントに「当時考えていた事を記録する」事で、デバッグや、動作を拡張する時に大いに役立ちます。

少し面倒ですが、凝った処理をしようとすればする程、未来の自分に向けてログを残す事は重要だと思います。

いつも自分の作ったイベントに苦しめられている…という方は是非やってみて下さい♪