Visual Studio Tools for Unity [Unity/Visual Studio]

Visual Studio Tools for Unity

機能

• IntelliSense：コード補完
• デバッグ機能
  • ブレークポイント
  • ウォッチ
  • 変数、引数の検査、及び変更
  • オブジェクトやデータ構造体を展開
• アナライザー／コード修正
• CodeLens サポート
• Unity Project Explorer (UPE)

参考：

Visual Studio Tools for Unity | Microsoft Docs [公式]

導入

参考：

Visual Studio Tools for Unity の使用を開始する | Microsoft Docs [公式]

使い方

参考：

Unity で Visual Studio を使う – Qiita

Unity で Visual Studio をデフォルトのエディタに設定する – Qiita

Visual Studio 2019 を Unityで使用する。| 58 の Unity や技術のヤマカン！

Visual Studio 2019 を使おう！| のらくるノート

VS2017 から VS2019 へ環境を移動する。| 土屋つかさの技術ブログは今か無しか

Visual Studio 2019 で保存する度にコンパイルされる問題 | のらくるノート

Visual Studio Tools for Unity を使用する | Microsoft Docs [公式]

Visual Studio C# インテグレーション | Unity マニュアル [公式]

Unity Editor から Visual Studio を起動する

メニューから「Assets > Open C# Project」を選択して開く。

参考：

Visual Studio で Unity スクリプトを開く | Microsoft Docs [公式]

ドキュメントを閲覧する

メニューから「ヘルプ > Unity API リファレンス」を選択して開く。ローカルにマニュアルをインストールした場合はローカルのマニュアルを開く。ローカルにマニュアルが存在しない場合はオンラインで開く。

参考：

Unity のドキュメントへのアクセス | Microsoft Docs [公式]

Launch local documentation from unity 2018.2.5 – Stack Overflow

.csproj ファイルを生成する

インテリセンスを使用してコード補完を行うためには .csproj ファイルが適切に生成されている必要がある。

.csproj ファイルを生成する範囲を設定するには、メニューから「Edit > Preferences…」を開いて、External Tools タブで 「Generate .csproj files for」の項目を設定する。デフォルトでは、埋め込みパッケージとローカルパッケージのみが有効となっている。

• Embedded packages：埋め込みパッケージ
• Local packages：ローカルパッケージ
• Registry packages：レジストリからインストールしたパッケージ
• Git packages：Git プロトコルでイントールしたパッケージ
• Built-in packages：ビルトインパッケージ
• Local tarball
• Packages from unknown sources
• Player projects

「Regenerate project files」ボタンを押すと .csproj ファイルが再生成される。

参考：

Package Manager で追加したパッケージの .csproj を生成する方法 | コガネブログ

「Generate all .csproj files.」をオンにしていても .csproj が生成されない場合 | コガネブログ

External Tools | Unity 2018.4 マニュアル [公式]

Searching code in Package Manager from Visual Studio – Unity Forum

Is there a way to force Unity to regenerate csproj files? – Unity Forum

How to get intellisense setup for a custom embedded package? – Unity Forum

“Step into” package scripts? – Unity Forum

Imported package’s code not showing in Visual Studio – Stack Overflow

互換性のないプロジェクト

現象

Visual Studio でプロジェクトを開くと次のような警告メッセージが表示される。

この Unity プロジェクトは、Visual Studio Tools for Unity 用に生成されたものではありません。

対処法

1. メニューから「Edit > Preferences…」を開く。
2. 「External Tools」タブに切り替えて、「External Script Editor」として「Visutal Studio Community 2019」が選択されていることを確認する。
3. 「Regenerate project files」を実行する。

参考：

Visual Studio での互換性のないプロジェクト | Microsoft Docs [公式]

トラブルシューティング

参考：

トラブルシューティングと既知の問題 | Microsoft Docs [公式]

Tips

参考：

Unity でコーディングするときに Visual Studio ツールを最適化するためのヒント | Unity [公式]

Roslyn Analyzers for Unity

参考：

microsoft/Microsoft.Unity.Analyzers: Roslyn Analyzers for Unity Game Developers – GitHub

Microsoft.Unity.Analyzers | NuGet Gallery [Official]

Microsoft.Unity.Analyzers/doc – GitHub

サードパーティのアナライザーのインストール | Microsoft Docs [公式]

how to install analyzers · Issue #80 · microsoft/Microsoft.Unity.Analyzers – GitHub

UNT0014 警告

参考：

GetComponent called with non-Component (UNT0014) triggers on generic type parameters with Component constraint · Issue #71 · microsoft/Microsoft.Unity.Analyzers – GitHub

Check generic type parameters in UNT0014 diagnostic by KonH · Pull Request #72 · microsoft/Microsoft.Unity.Analyzers – GitHub