發佈 Visual Studio 擴充功能的最佳做法檢查清單

以下是在發佈 Visual Studio 擴充功能之前，務必記住的事項清單。

下列影片介紹了最佳做法，以確保您的擴充功能達到最佳狀態。

遵循執行緒規則

將 Microsoft.VisualStudio.SDK.Analyzers NuGet 套件新增至 VSIX 專案，以協助您探索並修正執行緒上常見之最佳做法違規。

新增高品質圖示

所有擴充功能都應該有一個關聯圖示。 請確定圖示是高品質的 .png 檔案，大小 90x90 像素，96 DPI 或更高。 將圖示新增至 VSIX 專案之後，請在 .vsixmanifest 檔案中將其註冊為圖示和預覽影像。

名稱和描述

研究表明，具有簡短和描述性名稱和精確描述的擴充功能，更有可能被使用者安裝。 請確定該名稱可反映擴充功能的本質。 .vsixmanifest 檔案中的簡短描述，應該設定對擴充功能的期望 。 因此，簡要說明擴充功能所解決的問題，及其具有哪些主要功能是關鍵。

撰寫良好的 [市集] 描述

為了讓您的擴充功能成功發佈，這是應該執行的最重要動作之一。 良好的描述包含：

• 擴充功能所新增 UI 的螢幕擷取畫面/動畫 GIF。
• 個別功能的詳細描述。
• 如果適用，連結更多詳細資料。

新增授權

此授權會顯示在 [市集]、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,)。 深入了解版本範圍。