Microsoft發布了新的.NET API閱讀器。該閱讀器可以查找所有相關的.NET文檔。第一版中包括了.NET Framework、.NET Core、.NET Standard、Xamarin和Azure NuGet軟件包的參考文檔，并可根據用戶反饋添加其它領域的文檔。
該閱讀器提供了在同一處搜索、展示、發現和瀏覽全部.NET兼容SDK文檔的標準方式。搜索引擎不再需要查找相關的文檔，也不再需要查找適當軟件包的下載位置，這將提高開發人員的生產率。
類似于IntelliSense的工作方式，在API閱讀器中也可以使用全名或是部分信息直接搜索命名空間、類或方法。關鍵字輸入時，會列出可供選擇的列表。用戶可以搜索所有的API，或通過選取一系列Quick Filter縮小搜索的空間。使用過濾搜索選項，用戶可以選取具有C#、VB或C++例子的文檔，也可以指定想要搜索的.NET版本。用戶不再需要操心某個類型是否包含在特定的版本中。在閱讀器的頂部，提供了一個API目錄表，籍此用戶可通讀文檔。閱讀器還提供PDF文件下載。
更重要的信息會在閱讀器中優先展示，這提高了文檔的可讀性。相對于詳細的文檔，總體概覽和編程例子（按語言過濾）是優先提供的。在瀏覽命名空間、類型或成員的文檔時，瀏覽器左邊的目錄表都將會為用戶展示下一層級的信息，讓用戶了解所查找內容的上下文。
閱讀器還提供了持續集成工具，軟件發布后數小時內就能提供可用的準確文檔。所管理的參考文檔是從NuGet或各.NET Framework發行版中自動生成的。生成文檔時使用的是DocFX和mdoc等開源工具。
社區對文檔的貢獻功能將于下個月提供。由于文檔使用了ECMAXML格式，所有的SDK具有一致的格式。貢獻者可以使用Markdown將內容嵌入到自動生成的文檔中。用戶無需操心文檔文件的格式。
用戶可以通過User Voice網站請求文檔改進，并對重要建議的選取進行投票。建議中包括用戶想在API閱讀器中看到的額外添加文檔。用戶也可通過Twitter帳號@docsmsft請求快速更新。
查看英文原文： Announcing a Unified .NET Documentation Experience
京公網安備 11010502049343號