写点什么

统一的.NET 文档体验发布

  • 2017-05-04
  • 本文字数:813 字

    阅读完需:约 3 分钟

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

2017-05-04 19:002109
用户头像

发布了 227 篇内容, 共 83.0 次阅读, 收获喜欢 28 次。

关注

评论

发布
暂无评论
发现更多内容

Databend 源码阅读系列(一): 开篇

Databend

源码阅读 源码剖析 云平台 大数据 开源 databend

详解 Sqllogictest

Databend

大数据 databend Sqllogictest

SpringCloud 注册中心 (Eureka) 快速入门

微服务 Eureka SpringCould 8月月更

另眼旁观 Linkerd 2.12 的发布:服务网格标准的曙光?

张晓辉

云原生 kuberne Linkerd 服务网格

2022 世界人工智能大会|人工智能与开源技术先锋论坛即将开幕

Kyligence

开源技术 人工智能大会

java程序员培训学习需要多长时间?

小谷哥

设计模式的艺术 第十章桥接设计模式练习(设计一个数据转换工具,可以将数据库中的数据转换成多种文件格式,例如txt、xml、pdf等格式,同时该工具需要支持多种不同的数据库)

代廉洁

设计模式的艺术

10大常用的排序算法(算法分析+动图演示)

Five

算法 排序算法 8月月更

你还有什么问题吗?

AlwaysBeta

程序员 面试

SpringCloud Eureka参数配置项详解

echoes

大厂裁员小厂跑路,是时候做这件事了,否则到时可别后悔!!!

CRMEB

web前端培训学习应该注意什么

小谷哥

为什么MatrixOne 0.5变慢了

MatrixOrigin

矩阵起源 MatirxOrigin MatirxOne 因子化

leetcode 227. Basic Calculator II 基本计算器 II(中等)

okokabcd

LeetCode 算法与数据结构

ClickHouse与Elasticsearch压测实践

京东科技开发者

elasticsearch 分布式 数据分析 Clickhouse 数据库·

如何有效改进回顾会议(下)?

敏捷开发

Scrum 回顾会 Scrum团队

分分钟带你了解 ES2022 最重要的 4 个特性!

掘金安东尼

前端 8月月更 ES2022

选择web前端培训机构需要注意什么?

小谷哥

研发管理 DevOps 最佳实践之三问三答

极狐GitLab

DevOps gitlab CI/CD 代码规范 gitops

Tapdata 获得阿里云首批产品生态集成认证,携手阿里云共建新合作

阿里巴巴云原生

阿里云 Serverless 云原生 SAE 合作

【小程序项目开发 --- 京东商城】 启航篇之uni-app项目搭建

计算机魔术师

8月月更

Databend v0.8 新版本上线!

Databend

开源社区 云平台 大数据 开源 databend

如何快速地学习东西(下篇)

宇宙之一粟

学习方法 8月月更

深圳选择java培训机构哪家靠谱?

小谷哥

一文读懂数据科学Notebook

Baihai IDP

人工智能 ide AI notebook 数据科学

项目经理和ScrumMaster可以是同一个人吗?

ShineScrum

Scrum 敏捷 ScrumMaster 项目经理

参加大数据培训机构学习前景怎么样

小谷哥

建成 5000 多间「梦想中心」后,他们决定将技术开源

腾源会

开源 公益 腾源会

无需编写一行代码,实现任何方法的流量防护能力

阿里巴巴云原生

阿里云 微服务 云原生 流量

【小程序】view视图,swiper轮播图,scroll-view滑动列表 (在线详细手册)

计算机魔术师

8月月更

【小程序项目开发-- 京东商城】uni-app开发之配置 tabBar & 窗口样式

计算机魔术师

8月月更

统一的.NET文档体验发布_.NET_Michael Stiefel_InfoQ精选文章