【Unity】スクリプト一覧にコメントを表示して開発効率UP！

はじめに

「あれ、このスクリプトって何の実装だっけ…？」プロジェクトフォルダの一覧を見て、何のスクリプトか分からなくなること、ありませんか？ 僕はよくあります！

連休を利用して、久しぶりにゲーム制作を再開しました。そこで、自作のカスタムアクション一覧を見ていて、「このスクリプトは何をするものだっけ？」と、毎回スクリプトを開いてコメントを確認する手間を痛感したんです。これは面倒だな～と思い、スクリプトのコメントをエディター上に表示するスクリプトを作ってみました！ これで、スクリプトを開かなくても、どんな処理をするものか一目で分かりますね！

使い方

使い方はとっても簡単です！ まず、こちらのスクリプトをプロジェクトのEditorフォルダに入れてください。

スクリプトを入れたら、あとはC#スクリプトの先頭に/* コメント */のようにコメントを記入するだけ！ そのコメントが、エディター上でスクリプト名の横に表示されるようになります。とってもシンプルでしょ？

もし、別の記号でコメントを表示させたい場合は、コード内のExtractFirstCommentという部分を修正してみてくださいね。

ほら、こんな感じでスクリプトの横にコメントが表示されるようになりました！ これで、スクリプトの役割が一目で分かりますね！

おわりに

ゲームロジック側のカスタムアクションだけで20個以上のスクリプトがあったので、スクリプトのコメントがエディタ上で見えるようになったことで、可視性が格段に向上しました！ これで、より集中してゲーム制作に取り組むことができそうです！ 同じように悩んでいる方がいれば、ぜひ試してみてくださいね！

補足：文字化け対策

もしエディター上のコメントが文字化けする場合は、`.editorconfig`というファイルにcharset = utf-8という設定を追記してみてください。`.editorconfig`ファイルがない場合は、プロジェクトフォルダのルートに`.editorconfig`ファイルを作成し、以下の内容を記述してください。

# Top-most EditorConfig file
root = true
# encode
[*.cs]
charset = utf-8

`.editorconfig`ファイルについて、もっと詳しく知りたい方は、以下のMicrosoftのドキュメントを参考にしてみてください。