NVIDIA 初创加速计划,免费加速您的创业启动 了解详情
写点什么

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

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

关注

评论

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

030云原生之交付部署

穿过生命散发芬芳

云原生 10月月更

公关CRM软件助你培养长期客户关系

低代码小观

CRM 管理系统 管理工具 管理软件 公关

CODING 助力江苏高速信息实现组织敏捷与研发敏捷,领跑智慧交通新基建

CODING DevOps

研发敏捷 组织敏捷 自动化发布流程 团队目标一致性 楼宇智能化

OCR+NLP信息抽取在金融、物流行业的应用

百度大脑

人工智能 百度

泛型原理解析(Review)

Puciu

泛型

如何成为一个更好的职业人?

石云升

学习笔记 职场经验 10月月更

使用 Spring Boot 和 @DataJpaTest 测试 JPA 查询

码语者

Java Spring Boot test

ES入门教程

阿强

elasticsearch elastic ES

Python代码阅读(第47篇):从列表右边开始执行给定函数

Felix

Python 编程 Code Programing 阅读代码

OCR+NLP 提取信息并分析,这个开源项目火了!

百度开发者中心

最佳实践 开源技术

虚拟人“觉醒”年,见证一场万物的进化

脑极体

[ CloudWeGo 微服务实践 - 02 ] 上手

baiyutang

golang 微服务 10月月更

AISWare AntDB亚信科技数据库产品特性解读——平滑弹性扩展(一)

亚信AntDB数据库

亚信科技

作业:模块一

奔奔

Android 音视频 - MediaCodec 编解码音视频

声网

android 音视频 编解码

阿里大牛首次公布Java10W字八股文面经,Github访问量破百万

Java 编程 程序员 架构 面试

永不落幕的世界智能盛会:天津市工业和信息化局与工商银行天津分行举行对接交流活动

InfoQ 天津

北森CEO纪伟国:深耕HR SaaS,聚焦场景一体化

海比研究院

科技赋能乡村振兴,农林牧渔如何“拥抱”区块链技术?

CECBC

文本逆序翻转工具

入门小站

工具

linux之zgrep查找压缩包文件文本

入门小站

Linux

OpenSearch 文档如何进行编译

HoneyMoose

中国央行数字货币DCEP——有增值空间吗?

CECBC

【浪潮云说】直播间第十期将于今晚19:30准时开播

浪潮云

云计算

第六届世界智能大会平行论坛提前揭晓

InfoQ 天津

网易云信 6 周年|以梦为马,谱写融合通信新篇章

网易云信

云通信 通信云

少吃肉也能减碳排?

脑极体

浅谈如何实现自定义的 iterator

hedzr

stl Iterator c++17

微信朋友圈的复杂度分析

胡颖

架构实战营

通过题目来讲一讲计算机系统概述相关知识 3 | 计算机组成与系统结构专题

Regan Yue

计算机组成原理 10月月更

优雅代码技巧

十二万伏特皮卡丘

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