这篇文章是由云 + AI 部门项目经理 den Delimarsky 撰写的。
我们很高兴地宣布从 MSDN 到 docs.microsoft.com11 个区域设置中完成所有 .NET Framework 文档的迁移。 若要了解此迁移的卷和规模,.NET Framework 内容表示整个 MSDN 库的 900 万 API 文档或 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 浏览器)。
版本控制支持
你不再需要怀疑类型是否具有特定版本的 .NET Framework 或 Azure 存储 NuGet 包中可用的成员 - 只需从 API 浏览器控件更改版本,内容将相应地进行调整:
.NET 文档中 
改进的组织
在左侧目录中,内容按命名空间和该命名空间中的实体类型进行分组。 例如,选择类时,将看到实体按各自的类型对实体进行分组:属性、字段、方法和 事件。
或者,还可以借助 .NET API 浏览器进行搜索,甚至筛选特定 API 版本,所有这些版本都来自目录,从而轻松找到要查找的确切 API。
客户还告诉我们,当你在 API 参考页中时,有时很难找到 API 的下载、设置和其他有用的文档。 如下图所示,Azure .NET SDK 将文章和参考文档合并在一个目录中!
直观的 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 一样,Docs 支持所有 .NET 语言,包括 C#、VB、F# 和 C++
文档语言选取器
在浏览器中以交互方式运行示例
使用代码时,学习的最佳方法是实际编写代码 - 我们希望确保你可以直接从浏览器执行此操作。 一年前,我们推出了 试用 .NET 功能,并在一年内将其集成到了一些文章中。 今后,我们将继续在更多 API 文档中集成此功能,这样就可以在不离开页面的情况下进行试验。
在浏览器中交互式 .NET 代码
标准自动生成工具支持
自动生成有关 docs.microsoft.com 的所有 API 文档,使我们能够轻松记录整个 API 图面,并极大地缩短了从几周到几分钟的更新时间和频率。 这可确保获取所有 .NET API 的质量 API 文档。
为此,我们与 Xamarin 工程团队合作开发并使用 mdoc 生成所有 .NET 参考文档。
MSDN 链接 - 重定向到 docs.microsoft.com
在开始迁移时,我们希望确保没有链接中断-所有这些可能集成到产品、博客文章和其他网站的 MSDN 链接都应正常工作,并将用户指向新位置,并借助标准 301 重定向。
为社区贡献做好准备
所有迁移的内容现在都是开源的,位于 GitHub 上的 dotnet/dotnet-api-docs 存储库中。 但是,无需搜索文件即可做出贡献 - 只需转到任何 .NET API 页面并单击 编辑,即可直接转到要更改的文件。