Microsoft發(fā)布了新的.NET API閱讀器。該閱讀器可以查找所有相關(guān)的.NET文檔。第一版中包括了.NET Framework、.NET Core、.NET Standard、Xamarin和Azure NuGet軟件包的參考文檔，并可根據(jù)用戶反饋添加其它領(lǐng)域的文檔。

該閱讀器提供了在同一處搜索、展示、發(fā)現(xiàn)和瀏覽全部.NET兼容SDK文檔的標(biāo)準(zhǔn)方式。搜索引擎不再需要查找相關(guān)的文檔，也不再需要查找適當(dāng)軟件包的下載位置，這將提高開發(fā)人員的生產(chǎn)率。

類似于IntelliSense的工作方式，在API閱讀器中也可以使用全名或是部分信息直接搜索命名空間、類或方法。關(guān)鍵字輸入時(shí)，會(huì)列出可供選擇的列表。用戶可以搜索所有的API，或通過選取一系列Quick Filter縮小搜索的空間。使用過濾搜索選項(xiàng)，用戶可以選取具有C#、VB或C++例子的文檔，也可以指定想要搜索的.NET版本。用戶不再需要操心某個(gè)類型是否包含在特定的版本中。在閱讀器的頂部，提供了一個(gè)API目錄表，籍此用戶可通讀文檔。閱讀器還提供PDF文件下載。

更重要的信息會(huì)在閱讀器中優(yōu)先展示，這提高了文檔的可讀性。相對(duì)于詳細(xì)的文檔，總體概覽和編程例子（按語(yǔ)言過濾）是優(yōu)先提供的。在瀏覽命名空間、類型或成員的文檔時(shí)，瀏覽器左邊的目錄表都將會(huì)為用戶展示下一層級(jí)的信息，讓用戶了解所查找內(nèi)容的上下文。

閱讀器還提供了持續(xù)集成工具，軟件發(fā)布后數(shù)小時(shí)內(nèi)就能提供可用的準(zhǔn)確文檔。所管理的參考文檔是從NuGet或各.NET Framework發(fā)行版中自動(dòng)生成的。生成文檔時(shí)使用的是DocFX和mdoc等開源工具。

社區(qū)對(duì)文檔的貢獻(xiàn)功能將于下個(gè)月提供。由于文檔使用了ECMAXML格式，所有的SDK具有一致的格式。貢獻(xiàn)者可以使用Markdown將內(nèi)容嵌入到自動(dòng)生成的文檔中。用戶無(wú)需操心文檔文件的格式。

用戶可以通過User Voice網(wǎng)站請(qǐng)求文檔改進(jìn)，并對(duì)重要建議的選取進(jìn)行投票。建議中包括用戶想在API閱讀器中看到的額外添加文檔。用戶也可通過Twitter帳號(hào)@docsmsft請(qǐng)求快速更新。

原文地址：http://www.infoq.com/cn/news/2017/05/dotnet-unified-documentation

---

.NET社區(qū)新聞，深度好文，微信中搜索dotNET跨平臺(tái)或掃描二維碼關(guān)注

總結(jié)

以上是生活随笔為你收集整理的统一的.NET文档体验发布的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。