Nodachisoft Nodachisoft logo, Katana Sword Icon
  
@あまじ✎ 2021年12月26日に更新

Unity+VSCode で快適な開発環境を作る

Unity+VSCode で快適な開発環境を作る

概要

Unity + VSCode で快適な開発環境を作るときの手順についてメモしたもの。

環境・ソフトウェア

ソフトウェア バージョン
Unity Unity2020.3 LTS
OS Windows 10 Home
VSCode 1.63.2

Unity と VSCode をインストール

Unity は特に理由がなければ、安定版(LTS)をインストールする。

VSCode も以下からダウンロード&インストール可能。

Chocolatey などのパッケージ管理ツールからもインストールできる。

Unity から VSCode を標準で開くようにする

Unity 内でスクリプトを選択したときや、プロジェクトを開いたときの 標準のエディタを、「VSCode」に切り替える。

Unity 上で Edit -> Preferences を選択し、

Set Default Open ide

Preferences のウィンドウの左側からExternal Tools -> External Script EditorVisual Studio Code に設定します。

externaltools

Unity プロジェクトの中身を VSCode で開いてみる

現在の Unity プロジェクトを VSCode で開ける。 Assets -> Open C# Projec で VS Code で開くことができる。

OpenVSCode

拡張プラグインの導入

Unity + VSCode だけだと、まだコーディングするには不便。

効率よく開発を進められるよう、以下の拡張プラグインを導入しておく。

VSCode で導入した拡張プラグインは以下の通り。

プラグイン名 概要
C# for Visual Studio Code C# を VSCode 上でコーディングする際に補完してくれる
Debugger for Unity Unity で実行した際にブレークポイントなどでデバッグ可能
Unity Code Snippets Unity で頻繁に使用するコードが簡単にコード補完で生成できる
c# XML Documentation Comments C# を VSCode 上でコーディングする際のコメントの記述を補完してくれる

いずれも、VSCode の「拡張機能」からプラグインとしてすぐにインストール可能。

以下、各拡張プラグインについて簡単に要点のみ記載しておく。

C# for Visual Studio Code

.NET Core または Mono で実行されている C# のコーディングをサポートできるようになる。

以下のように書きかけのコードでCtrl+Space などで補完できる。

補完例

.NET Framework の開発 Unity とは直接関係ないのですが、VSCode は昔ながらの Windows Native の機能を使う .NET Framework を使った開発には向いていないです。(不可能ではない) .NET Framework 開発するなら、 VSCode ではなく、Microsoft Visual Studio Community を使ったほうが、関連ライブラリのコード補完やデバッグなどが充実しています。

Debugger for Unity

VSCode 上のコードでブレークポイント(一時的に実行を止めて、変数などの中身を確認する等の便利機能)を貼ることができる。

BreakPoint

コードで止めたい場所の左側をマウス左クリックすることでブレークポイントを貼ることができる。

例えば、上のコードでUnity を実行してブレークポイントの行で止め、変数 a の中身がどうなっているかを確認することができる。

実際にブレークポイントで停止させるにあたり、VSCode 上から、どの Unity Editor と関連図けるのかを指定しておく。

VSCode のコマンドパレットを Ctrl+Shift+P で開き、 「Unity Attach Debugger」を選択する

launch unity attach debugger

複数の Unity Editor が起動しているなら、選択しが表示される。

Menu Which unity editor you want to attach

Unity Editor にデバッガが接続すると、以下のように VSCode 上でデバッグのための情報が表示されるようになる。

Debug Mode

また、初めて Debugger を Unity につなげる場合、Unity 側にもデバッグできるよ!というメッセージが表示される。

Unity Editor inform that debugger connected to

実際にブレークポイントを貼ったり、デバッグをする方法についてはここでは省略。(別にまとめたいな)

Unity Code Snippets

Unity 関連のライブラリについて、定型的に作成が必要なテンプレコードなどが利用できるようになる。

例えば、新しく適当な .cs スクリプトを作り「Mono」と入力すると 下のように「MonoBehaviour」がコード補完リストに表示されるようになる。

Mono

この状態でコード補完すると、

Codehokan

こんな感じでテンプレート的に Unity コンポーネントを作るときの基底クラスである MonoBehaviour を 継承したクラスのひな形(一般にボイラーテンプレートと呼ばれる)を生成できる。

これ以外にも、 MonoBehaviour を継承したクラス内で、「Start」と入力すれば、以下のように必要なテンプレート的なメソッドを生成してくれる。

Start

また、よく使う Unity のログ出力へのコード等も補完機能で生成できる。

Log

c# XML Documentation Comments

C# コーディングでコメントを入れるときに、必要なテンプレートを補完してくれる。

例えば、以下のような定義の直前に「///」とコメントを入れると

var

自動的に以下のようにコメント挿入のテンプレを生成してくれる。

commentinserted

便利です。

メソッドについても必要なコメントのテンプレを生成してくれます。 以下のようなコードの直前で「///」と入力すると、

method

以下のように引数や戻り値などのテンプレも一緒に生成してくれます。

methodcommentinserted

トラブル

コードがうまく補完されない場合には以下の記事をご参照いただくと、解決できるかもしれません!

参考

変更履歴

日付 変更概要
なし
 
 
送信しました!

コメント、ありがとうございます。

なんかエラーでした

ごめんなさい。エラーでうまく送信できませんでした。ご迷惑をおかけします。しばらくおいてから再度送信を試していただくか、以下から DM などでご連絡頂ければと思います。

Twitter:@NodachiSoft_jp
お名前:
 
連絡先:
 
メッセージ:
 
戻る
内容の確認!

以下の内容でコメントを送信します。よろしければ、「送信」を押してください。修正する場合は「戻る」を押してください

お名前:
 
連絡先:
 
メッセージ:
 
Roboto からの操作ではないという確認のため確認キーを入れてください。
確認キー=95
戻る
 / 
送信確認へ
コメント欄
コメント送信確認へ

関連ありそうな記事(5件)です!

Unity の C# コードで System.Type.GetType が null を返してしまう

Unity の C# コードで System.Type.GetType が null を返してしまう

#Unity#.net✎ 2022-1-11
Unity の C# コードで System.Type.GetType が null を返してしまう
目次
Unity+VSCode で快適な開発環境を作る
Unity+VSCode で快適な開発環境を作る
概要
概要
環境・ソフトウェア
環境・ソフトウェア
Unity と VSCode をインストール
Unity と VSCode をインストール
Unity から VSCode を標準で開くようにする
Unity から VSCode を標準で開くようにする
Unity プロジェクトの中身を VSCode で開いてみる
Unity プロジェクトの中身を VSCode で開いてみる
拡張プラグインの導入
拡張プラグインの導入
C# for Visual Studio Code
C# for Visual Studio Code
Debugger for Unity
Debugger for Unity
Unity Code Snippets
Unity Code Snippets
c# XML Documentation Comments
c# XML Documentation Comments
トラブル
トラブル
参考
参考
変更履歴
変更履歴
Nodachisoft © 2021