10 月 23 - 25 日,QCon 上海站即将召开,现在购票,享9折优惠 了解详情
写点什么

统一的.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:002122
用户头像

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

关注

评论

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

【Flutter 专题】69 图解基本 Stepper 步进器

阿策小和尚

Flutter 小菜 0 基础学习 Flutter Android 小菜鸟 8月日更

Vue进阶(二十八):浅析 Vue 中 computed 与 method 区别

No Silver Bullet

Vue 8月日更 computed

FastApi-10-Example

Python研究所

FastApi 8月日更

【LeetCode】二叉树的镜像Java题解

Albert

算法 LeetCode 8月日更

Debian 10 安装 phpMyAdmin

Tao

MySQL 服务器 PHP-FPM MariaDB Debian

学习笔记:HTTP消息的响应码

姬翔

如何评价《Java 并发编程艺术》这本书?

苹果看辽宁体育

书籍推荐 java 并发

从0开始的TypeScriptの六:webpack5热更新打包TS

空城机

JavaScript typescript 大前端 8月日更

大厂offer?拿来吧你!网易有道笔试编程题特辑

有道技术团队

招聘 笔试 #技术干货# 网易有道

跟我读论文丨ACL2021 NER 模块化交互网络用于命名实体识别

华为云开发者联盟

自然语言处理 机器学习 ACL2021 NER 模块化交互网络 实体识别

Apache Pulsar 里程碑简史:打造统一消息流平台与生态

Apache Pulsar

Apache Pulsar StreamNative

LeetCode题解:783. 二叉搜索树节点最小距离,递归,JavaScript,详细注释

Lee Chen

算法 大前端 LeetCode

4种基于像素分割的文本检测算法

华为云开发者联盟

目标检测算法 文本检测 像素分割 文本检测算法 文本

Go 学习笔记之 反射

架构精进之路

Go 语言 8月日更

“互联网+”大赛之智慧校园赛题攻略:你的智慧校园,WeLink帮你来建

华为云开发者联盟

小程序 华为云 welink 智慧校园 “互联网+”大赛

3 条掏心掏肺的建议,新手学习编程必备,快上车!

沉默王二

编程

Spring @Transactional 注解事务

Rubble

springboot 8月日更

Go协程并发之百万级并发「让我们一起Golang」

Regan Yue

高并发 协程 Go 语言 8月日更

Compose 中的 ConstraintLayout

Changing Lin

8月日更

2021年8月国产数据库排行榜:TiDB稳榜首,达梦返前三,Kingbase进十强,各厂商加速布局云生态

墨天轮

数据库 opengauss TiDB oceanbase 国产数据库

【Vue2.x 源码学习】第三十四篇 - 组件部分-Vue组件与初始化流程简介

Brave

源码 vue2 8月日更

手撸二叉树之二叉树的最近公共祖先

HelloWorld杰少

数据结构与算法 8月日更

API纠错+翻译,就等您大展身手!

Geek_6cdeb6

Java Array 和 String 的转换

HoneyMoose

解决「停车难」,EMQ 映云科技数据接入方案在智慧停车平台中的应用

EMQ映云科技

大数据 物联网 移动互联网 智慧交通 emq

主打年轻群体,2022款欧拉黑/白猫6.98万元起正式预售!

科技热闻

三分钟看完单例模式的八个例子

4ye

Java 后端 设计模式 单例模式 8月日更

云小课 | 网络知识一箩筐——NAT网关,让IP地址华丽变身,轻松实现内外网互通

华为云开发者联盟

私网NAT网关 NAT网关 公网NAT网关

源码级深挖AQS队列同步器

码农参上

AQS 锁机制 8月日更

netty系列之:文本聊天室

程序那些事

Java Netty nio 程序那些事

「免费开源」基于Vue和Quasar的前端SPA项目crudapi后台管理系统实战之EXCEL数据导出(十三)

crudapi

Vue crud crudapi qusar 数据导出

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