閱讀英文

共用方式為


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

此文章是由 Cloud + AI 部門項目經理 den Delimarsky Den Delimarsky 所撰寫。

我們很高興宣佈從 MSDN 到 docs.microsoft.com11 個地區設定中所有 .NET Framework 檔的完整移轉。 若要瞭解此移轉的數量和規模,.NET Framework 內容代表超過 900 萬個 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 搜尋索引,可讓您在幾秒內快速尋找必要的 API,並搭配產品和版本篩選器 -.NET API Browser

.NET API 瀏覽器搜尋

版本控制支援

您不再需要懷疑類型是否具有特定版本的 .NET Framework 或 Azure 記憶體 NuGet 套件中可用的成員-您只需要從 API 瀏覽器控制項變更版本,而且內容會據以調整:

.NET 檔中的版本選擇器

改善的組織

在左側目錄中,內容會依該命名空間內的實體命名空間和類型分組。 例如,當您選取類別時,您會看到我們依各自的類型將實體分組:PropertiesFields方法,以及 Events

實體群組

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

.NET API 瀏覽器頁面內搜尋

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

Azure API 中的 Fusion 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++

語言選擇器

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

使用程式代碼時,學習的最佳方式是實際撰寫程式代碼 -我們想要確定您可以從瀏覽器直接執行該程序代碼。 一年前,我們推出了 試用 .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 頁面,然後按兩下 [編輯],您就會直接前往您想要變更的檔案。

參與檔

我們希望您的意見反應

我們希望您享有新的內容格式-請在 GitHub Twitter 傳送意見反應給我們。