.NET API 檔已從 MSDN 移至 docs.microsoft.com

此文章是由 Cloud + AI 部門中的 Program Manager Den Delimarsky所撰寫。

我們很高興宣佈從 MSDN 到docs.microsoft.com 11 個地區設定中所有.NET Framework檔的完整移轉。 若要瞭解此移轉的數量和規模,.NET Framework內容代表超過 9 百萬個 API 檔,或整個 MSDN 程式庫的 20% 磁片區。

目標是提供統一、現代化且一致的體驗,以尋找及流覽 Microsoft 隨附的所有 .NET API、包含版本設定的深層支援、使用和執行 API 程式碼範例、使用及執行 API 程式碼範例,以及使用自動化輕鬆啟用 API 更新,以及支援社群貢獻。

docs.microsoft.com 可啟用下列體驗:

  • .NET Framework (1.1 - 4.7.2版)
  • .NET Core (1.0 - 2.1 版)
  • .NET Standard (1.0 - 2.0 版)
  • Microsoft 隨附的所有 .NET API、SDK 和 NuGet 套件

使用 .NET API 瀏覽器在單一位置搜尋所有 Microsoft .NET API

您是否曾經在想要尋找 API 的情況中,但您不知道要從何處開始? 我們已建置專用的 API 搜尋索引,可讓您在幾秒內快速找到必要的 API,以及產品與版本篩選器 - .NET API 瀏覽器

.NET API 瀏覽器搜尋

版本控制支援

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

.NET 檔中的版本選擇器

更清晰的組織方式

在左側目錄中,內容會依命名空間和該命名空間內的實體類型分組。 例如,當您選取類別時,您會看到我們會依其各自的類型將實體分組:屬性欄位方法和事件

實體群組

或者,您也可以使用 .NET API 瀏覽器的協助進行搜尋,甚至篩選特定 API 版本,全部都來自目錄,讓您輕鬆找到您要尋找的確切 API。

.NET API 瀏覽器頁面內搜尋

客戶也告訴我們,當您在 API 參考頁面內時,有時很難找到 API 的下載、設定和其他有用的檔。 如下圖所示, Azure .NET SDK 結合了文章和參考檔,全都在一個目錄中!

Azure API 中的融合 TOC

直覺式 URL

當我們最初啟動 docs.microsoft.com時,其中一個目標是要有清楚、一致且直覺的階層式 URL。 如果您記得使用 MSDN,某些 .NET URL 的結構如下:

https://msdn.microsoft.com/library/8kszeddc(v=vs.110).aspx

只要查看內容,就很難瞭解此內容是什麼。

上述連結現在會變成這樣:

https://docs.microsoft.com/dotnet/api/system.array.sort

以下是我們的 URL 書籍 中的一些 URL 規則,以確保 .NET 的一致且直覺式 URL:

命名空間

模式https://docs.microsoft.com/{locale}/dotnet/api/{namespace}

範例https://docs.microsoft.com/dotnet/api/system.collections.generic/

類別

模式https://docs.microsoft.com/{locale}/dotnet/api/{namespace}.{class}

範例https://docs.microsoft.com/dotnet/api/system.flagsattribute

方法

模式https://docs.microsoft.com/{locale}/dotnet/api/{namespace}.{class}.{method}

範例https://docs.microsoft.com/dotnet/api/system.decimal.add

第一個範例

我們從與客戶面試中聽到的一件事,就是 API 的高品質、簡潔和功能性程式碼範例的重要性。 在 MSDN 中,範例包含在頁面結尾,這表示在某些範例中,您需要向下捲動 20 次以上,才能查看類型的第一個範例。 在 Docs 上,範例會先顯示如下:

MSDN 與檔之間的範例比較

如同 MSDN,Docs 支援所有 .NET 語言,包括 C#、VB、F#和 C++

檔中的語言選擇器

在瀏覽器中以互動方式執行範例

使用程式碼時,學習的最佳方式是實際撰寫程式碼 - 我們想要確定您可以從瀏覽器直接執行此動作。 一年以前,我們推出 Try .NET 功能,並在一年內將其整合到許多文章中。 接下來,我們會繼續將這項功能整合到更多 API 檔中,讓您在不離開頁面的情況下進行實驗。

瀏覽器中的互動式 .NET 程式碼

標準自動產生工具支援

系統會自動產生 docs.microsoft.com 的所有 API 檔,讓我們可以輕鬆地記錄整個 API 介面,並大幅改善從周到分鐘更新的時間和頻率。 這可確保您取得所有 .NET API 的品質 API 檔。

為了這樣做,我們與 Xamarin 工程小組合作開發及使用 mdoc 來產生所有 .NET 參考檔。

當我們開始移轉時,我們想要確保沒有任何連結中斷 - 所有可能整合在產品中的 MSDN 連結、部落格文章和其他網站都應該正常運作,並將使用者指向新位置,並提供標準 301 重新導向的協助。

從 MSDN 重新導向至 docs.microsoft.com

準備好參與社群

所有移轉的內容現在開放原始碼 GitHub 上的dotnet/dotnet-api-docs存放庫中。 但您不需要搜尋檔案以做出貢獻 - 只要移至任何 .NET API 頁面並按一下 [ 編輯],您就會直接前往您想要變更的檔案。

參與編輯文件

我們非常重視您的意見

我們希望您喜歡新的內容格式,請在 GitHubTwitter上傳送意見反應給我們。