统一的.NET 文档体验发布

阅读数:898 2017 年 5 月 4 日

话题:.NETDevOps语言 & 开发架构

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 发行版中自动生成的。生成文档时使用的是DocFXmdoc等开源工具。

社区对文档的贡献功能将于下个月提供。由于文档使用了ECMAXML 格式,所有的 SDK 具有一致的格式。贡献者可以使用Markdown将内容嵌入到自动生成的文档中。用户无需操心文档文件的格式。

用户可以通过User Voice 网站请求文档改进,并对重要建议的选取进行投票。建议中包括用户想在 API 阅读器中看到的额外添加文档。用户也可通过 Twitter 帐号@docsmsft请求快速更新。

查看英文原文: Announcing a Unified .NET Documentation Experience