写点什么

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

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

关注

评论

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

TiDB 新特性解读 (6.0~6.6)

TiDB 社区干货传送门

管理与运维 版本测评 新版本/特性解读 6.x 实践 7.x 实践

TiDB与MySQL在备份容灾体系的衡量对比

TiDB 社区干货传送门

管理与运维

工程中实践的微服务设计模式

京东科技开发者

Kafka 线上性能调优

不在线第一只蜗牛

kafka 分布式

TiDB 版本升级常见问题处理(v6.0 及以上版本)

TiDB 社区干货传送门

版本升级 故障排查/诊断

尝鲜 TiDB 企业管理器TEM 2.1.3 新版本

TiDB 社区干货传送门

监控

RocketMQ 存储机制浅析

字节跳动云原生计算

RocketMQ

云PBX的相关介绍

cts喜友科技

通信 通讯 云通讯

NL2SQL技术方案系列(1):NL2API、NL2SQL技术路径选择;LLM选型与Prompt工程技巧,揭秘项目落地优化之道

汀丶人工智能

自然语言处理 text2sql NL2SQL

BizDevOps全局建设思路:横向串联,纵向深化

嘉为蓝鲸

DevOps Dev Ops BizDevOps

TiDB Vector抢先体验之用TiDB实现以图搜图

TiDB 社区干货传送门

数据库架构选型 新版本/特性解读 数据库前沿趋势

TiDB学习认证之路:数据库界的“快乐大本营”

TiDB 社区干货传送门

社区活动 学习&认证&课程

Python与数据库交互的最佳实践

技术冰糖葫芦

api 货币化 API 接口 pinduoduo API

我们开源啦!一键部署免费使用!Kubernetes上直接运行大数据平台!

智领云科技

开源 大数据平台 K8s 多集群管理

企业im即时通讯工具推荐,企业内部即时通讯软件工具怎么选?

BeeWorks

旅游电商的智能化升级:携程景点详情API引领新潮流

技术冰糖葫芦

API 接口 API 测试 pinduoduo API

全球AI音乐会,第一次听见中国声音

脑极体

AI

WorkPlus企业即时通讯国密加固-为企业信息安全保障

BeeWorks

PTCP认真学习始(不是错别字,啊喂

TiDB 社区干货传送门

社区活动 学习&认证&课程

记一次某节点没有Leader的问题分析

TiDB 社区干货传送门

实践案例 故障排查/诊断 7.x 实践

NL2SQL实践系列(2):2024最新模型实战效果(Chat2DB-GLM、书生·浦语2、InternLM2-SQL等)以及工业级案例教学

汀丶人工智能

text2sql NL2SQL

调试 WebSocket API 教程实践

Apifox

程序员 前端 后端 websocket WebSocket API

AI从入门到入门之手写数字识别模型java方式Dense全连接神经网络实现

京东科技开发者

写给职场新人|从迷茫到屡获殊荣的技术人成长之路

京东科技开发者

Create 2024 分论坛:百度大模型安全解决方案护航开发者一起创造未来

百度安全

一个游戏服务器多少钱?价格与配置的完美指南

一只扑棱蛾子

服务器

HAS2024:华为云以系统性创新加速千行万业智能化升级

华为云开发者联盟

云计算 华为云 华为云开发者联盟 企业号2024年4月PK榜 HAS2024

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