隆重介紹 docs.microsoft.com 上整合的 .NET 參考體驗

這篇貼文的作者是 Azure 成長與生態系統小組經理 Jeff Sandquist。

幾乎一年前，我們試驗 了 docs.microsoft.com 的 .NET Core 參考檔 。 今天，我們很高興宣布我們的統一 .NET API 參考體驗。 我們了解無論是業餘開發人員、新興公司或是企業，開發人員的生產力即關鍵。 我們將這點謹記在心並與 Xamarin 小組密切合作，共同將我們在 Microsoft 記錄、探索及巡覽 .NET API 的方式標準化。

所有 .NET 文件集於一處

以往若要尋找 Microsoft 隨附以 .NET 為基礎的 SDK，您必須使用慣用的搜尋引擎，花點時間嘗試尋找您可以加以下載之處及探索相關 API 文件的所在。

接下來，我們計劃擁有所有 。NET 相容 SDK 在單一位置統一且可搜尋： https://docs.microsoft.com/dotnet/api。 您會在該處找到 .NET Framework、.NET Core、.NET 標準及 Xamarin 的參考文件，以及我們的 Azure NuGet 套件文件。 在未來幾個月，我們會將更多 SDK 新增至這項體驗。

API 瀏覽器簡介

我們的主要目標是打造類似 IntelliSense、從瀏覽器搜尋所有 .NET API 的體驗。 您可以直接在 API 瀏覽器頁面中輸入命名空間、類別、方法或介面的完整或部分名稱來搜尋。

如果您不確定哪個 SDK 屬於特定類型、成員或命名空間，只要選取 [API 範圍] 下拉式清單中的 [所有 API]，然後搜尋所有可用的參考檔即可。或者，如果您想要限制搜尋，您可以選取特定的架構或 SDK 及其版本，例如，.NET Framework 4.7，並只在該組 API 內搜尋。

以.NET 為基礎的 API 的頂端目錄也整合了 API 瀏覽器體驗，讓您無論在參考文件內的何處都可快速找出任何 API：

您在特定的命名空間時，API 瀏覽器的範圍僅限相連接的 API 系列，因此您的搜尋一律會根據您的內容傳回盡可能的最佳結果。

版本控制支援

您不再需要揣測類型在特定版本的 .NET Framework 或 Azure 儲存體 NuGet 封裝中是否有可用的成員；您只需從 API 瀏覽器控制項變更版本，內容即會據以調整︰

將開放原始碼謹記在心進行建置

我們使用開放式標準和工具建置 API 瀏覽器。 基本上，我們運用 DocFX這項開放文件產生工具鏈，以及 Xamarin 的 mdoc 應用程式。

所有受管理的參考文件現在皆會自隨附於 NuGet 或是屬於主要架構散發的二進位檔自動產生，例如 .NET Framework 或.NET Core。

我們持續整合的基礎結構可讓我們擁有正確的最新 API 文件，這類文件現在只需幾小時即為公用且開放進行貢獻。 我們也以 ECMAXML 格式 將所有 .NET API 文件標準化，因此無論所記載的 SDK 為何，皆可建立一致且完整的 API 表示法。 此外，您不需要知道檔格式的複雜性，因為您可以在 Markdown 中參與內容，內嵌在自動產生的檔中。下個月將會啟用參考檔的社群貢獻。

專注於內容

除了全新的體驗外，我們也將參考內容最佳化，使其更容易探索及閱讀。 我們已將目錄更新為一律專注於命名空間。 無論您是在瀏覽命名空間、類型或成員的資訊，我們將一律只顯示父命名空間、其所有子系類型以及其個別的群組成員︰

這表示參考頁面會更為清晰，並先顯示最重要的資訊 (例如一般概觀和範例)，全部一目瞭然。

您也會在一開始就看到依據您所選的程式語言進行篩選且與您相關的範例，讓您不再需要捲動至頁面的最底部。

由意見反應所驅使

這僅是參考文件體驗煥然一新的起步。 我們想知道您的意見反應，了解我們能夠如何讓文件更加貼切實用，並讓您盡速步上正軌。 前往 UserVoice 網站，並讓我們了解如何改善 API 瀏覽體驗。 您也可以隨時透過 Twitter 與我們連絡， @docsmsft快速更新。