自作システムを作る場合、バグの発生はつきものなのでデバッグログで処理の経過を確認することは非常に重要です。ですが出力されるデバッグログが見づらいと何が何だか分からなくなってしまうため、なるべく見やすいログが出力されるようにしたいものです。そこで、今回はデバッグログを見やすくする工夫について書きます。
デバッグログを見やすくする工夫
私が最近よく使っている工夫は次の3つです。
- 処理ごとに区切り線を入れる
- 処理のタイトルを書く
- 処理の内容と結果を箇条書きする
これらのルールを適用すると、下の画像のようにデバッグログが読みやすくなります。
処理ごとに区切り線を入れる
コモンイベントの冒頭にデバッグ文で区切り線を入れるようにするとグッドです。処理と処理の境目が分かりやすくなるので劇的に読みやすくなります。
処理のタイトルを書く
処理のタイトルをデバッグ文で書いておくことで、今どの処理を行っているかが一目でわかるようになります。書式については何でもいいと思いますが、私の場合は「■処理のタイトル」という書き方を採用しています。
処理の内容と結果を箇条書きする
処理の内容や結果は箇条書きにしておくと読みやすいです。基本的には「・」にしておき、エラーの場合だけ目立つように「×」にするなどさらに工夫すると分かりやすいです。
以上、簡単ですがデバッグ文を読みやすくする工夫についてでした。一工夫するだけで劇的にログを読みやすくなるので、自作システムを作っている方はぜひ参考になさってください。
