Visual Studio 拡張機能を発行する前に覚えておく必要がある事項の一覧を次に示します。
次のビデオでは、拡張機能が最善であることを確認するためのベスト プラクティスについて説明します。
スレッドルールに従う
Microsoft.VisualStudio.SDK.Analyzers NuGet パッケージを VSIX プロジェクトに追加します。これは、スレッド処理に関するベスト プラクティスの一般的な違反を検出して修正するのに役立ちます。
高品質のアイコンを追加する
すべての拡張機能にアイコンが関連付けられている必要があります。 アイコンのサイズが 90 x 90 ピクセル (96 DPI 以上) の高品質の .png ファイルであることを確認します。 アイコンを VSIX プロジェクトに追加した後、アイコンとプレビューイメージの両方として .vsixmanifest ファイルに登録します。
名前と説明
調査によると、短くてわかりやすい名前と正確な説明を持つ拡張機能は、ユーザーがインストールする可能性が高くなります。 名前に拡張機能の機能の本質が反映されていることを確認します。 .vsixmanifest ファイルの簡単な説明は、拡張機能の動作に関する期待値を設定する必要があります。 だから、それが解決する問題とそれが持っている主な機能の簡単な言及が重要です。
Marketplace の適切な説明を記述する
これは、拡張機能を成功させるために行う必要がある最も重要なことの 1 つです。 適切な説明は次のとおりです。
- 拡張機能によって追加された UI のスクリーンショット/アニメーション GIF。
- 個々の機能の詳細な説明。
- 詳細 (該当する場合) へのリンク。
ライセンスの追加
このライセンスは、Marketplace、VSIX インストーラー、および [拡張機能と更新プログラム]... ダイアログに表示されます。 ユーザーの期待値を設定するには、常にライセンスを指定する必要があります。 choosealicense.com を使用して、適切なライセンスを見つけることができます。 ライセンスは、多くの Visual Studio ユーザーにとって重要な質問やあいまいさを取り除くために重要です。
プライバシーに関する通知を追加する
拡張機能がテレメトリなどのデータを収集する場合や、リモート エンドポイントと通信するその他の方法で収集する場合は、説明にメモを追加します。
可能な場合はKnownMonikersを使用する
Visual Studio には、 KnownMonikers コレクションで使用できる何千ものアイコンが付属しています。 コマンド ボタンにアイコンを追加する場合は、既存の KnownMonikers アイコンを使用できるかどうかを確認します。これは、Visual Studio ユーザーにとって使い慣れたデザイン言語の一部であるためです。 KnownMonikers の完全な一覧を次に示し、KnownMonikers Explorer 拡張機能を取得して、シナリオに適した拡張機能を見つけます。
VS に自然に感じられるようにする
Visual Studio 自体が使用するのと同じ設計パターンと原則に従って、拡張機能をユーザーに自然に感じさせます。 また、UI の設計が不十分な場合に発生する気が散る原因も減ります。 すべてのボタン、メニュー、ツール バー、ツール ウィンドウが既定で表示されるのは、ユーザーが使用する適切なコンテキストにある場合のみです。 従う経験則がいくつかあります。
- 新しいトップレベル メニュー ([ファイル]、[編集]、[...] の横) を追加しないでください。
- ボタン、メニュー、およびツール バーは、適用されないコンテキストで表示する必要はありません。
- 自動読み込みが必要な場合 (おそらくそうではない場合)、できるだけ遅くしてください。
- VisibilityConstraints を使用して、自動読み込みに依存するのではなく、コマンドの可視性を切り替えます。
適切なバージョン範囲を使用する
Visual Studio 2010 など、過去のバージョンの Visual Studio をサポートし、新しい拡張機能をすべてのユーザーが使えるようにすることは魅力的に思えるかもしれません。 その問題は、そうすることで、拡張機能がサポートする最小バージョンより後で導入された API を使用できなくなるということです。 多くの場合、これらの新しい API は重要であり、拡張機能と Visual Studio 自体の両方のパフォーマンスと信頼性の向上に役立ちます。
サポートする Visual Studio のバージョンを決定するための推奨事項を次に示します。
- 以前のバージョンと現在のバージョンの Visual Studio のみをサポートします。可能であれば、古いバージョンはサポートされません。
-
[16.0,)など、未終了のバージョン範囲を指定しないでください。 バージョン範囲の詳細を確認します。