【ウディタ】コモンイベントを読みやすくするための工夫

最近コモンイベントづくりの腕が上がってきたためか、以前よりも長めの200行程度のコモンを作る機会が多くなってきました。こうやってボリュームが増えてくると「いかに読みやすいコモンを作るか」が重要になってくるため、自分なりにいろいろ工夫してコモンが読みやすくなるように努めています。今回はその工夫についてメモしておきます。

コモンイベントを読みやすくする工夫5つ

私がコモンイベントを書くときに気を付けていることは次の通りです。

  • こまめにコメントを入れる
  • 変更履歴を残す
  • コモンイベント名は記号と色分けでわかりやすく
  • コモンイベントは機能ごとに分割する
  • 処理の流れを決めておく

以下、詳しく見ていきましょう。

こまめにコメントを入れる

一つ目は何と言ってもコメントです。コモンイベントを作ってしばらくすると処理の内容や理由を忘れてしまいがちですが、それだと後で変更するときに面倒なことになります。なのでそれを防ぐためにも

  • ここはどういう処理なのか
  • なぜそういう処理をするのか

を簡潔にコメントしておく癖をつけるといいでしょう。

また、ウディタはコマンドとコマンドのすき間が狭くてごちゃごちゃしやすいです。そこで私は処理と処理の間や条件分岐のところで適宜、空のコメントを入れて読みやすくなるようにしています。

ウディタで読みやすいコモンイベントを書く(1)

変更履歴を残す

コモンイベントを何度も加筆・修正していると、たまにバグったりして元に戻したくなることがあります。そういうときは本当はコピーをとってあれば安心なのですが、それがないときはどこでどういう変更を行っているのかが分からないと、最悪直しようがなくなってしまうこともあります。そういう事態にならないために変更履歴を残しておくのは重要です。下の図のように、コモンの先頭に日付と変更の内容をメモしておくといいでしょう。

ウディタで読みやすいコモンイベントを書く(2)

コモンイベント名は記号と色分けで分かりやすく

これは基本システムでも採用されているのですが、コモンイベント名に記号をつけたり、色分けしたりするとコモンの管理が楽になります。私の場合は次のようなルールで記号を付けたり、色分けしたりしています。

■見出し
★呼び出しのみのコモン
☆並列実行のコモン
★使用しなくなったコモン
★同名のコモンをコピーしたり、変更したコモン

特に、見出しを付けると処理やコモンのグループが一目でわかるので便利だと思います。

コモンイベントは機能ごとに分割する

一つのコモンに複数の機能を詰め込むと長くなりがちですし、処理も分かりづらくなってしまいます。なのでコモンイベントはなるべく分割するのがベターです。

処理の流れを決めておく

あらかじめコモンイベント内の処理の流れを決めておけば、追加や修正が必要になった時に変更すべき点が分かりやすくなります。例えば、私の場合はいつも処理の流れを次のように決めています。

  1. 必要な値の設定
  2. DBからデータ読み込み
  3. 読み込んだ値のチェック・修正
  4. 計算
  5. 一時変数の初期化
  6. 処理モードによる分岐
  7. 処理モードごとの処理

自作コモンのほとんどがこういう流れなので、どの部分がどうなっているのかが一目瞭然でわかりやすいです。