写点什么

使用 Roslyn 构建 Visual Studio 扩展

  • 2011-11-05
  • 本文字数:1530 字

    阅读完需:约 5 分钟

之前我们报道了 Roslyn 编译器和工作空间 API(Workspace API)。现在让我们来看下 Roslyn 的服务 API,以及我们能够如何使用它来扩展 Visual Studio。我们在本文中要查看的扩展包括代码问题报告、快速修正、代码重构、自动完成提供程序以及大纲视图。

和所有最新的 Visual Studio 扩展一样,服务 API(Service API)也是使用 MEF 注册的。这意味着开发者只需要实现特定的接口,并包含相符的 MEF 样式的属性就可以,与之前版本的 Visual Studio 相比,这项改变受到了大家的欢迎,之前我们需要使用代码签名以及 COM 注册才可以。

代码问题报告

代码问题报告(Code Issue)扩展让开发者可以编写自己的编译器警告和错误。在 CTP 版本中包含的实例为我们展示了,如何在语法树中出现字母“a”的地方显示警告。正如你在下面的图中所看到的,它很好地整合到 Visual Studio 的总体工作流程之中。

ICodeIssueProvider 接口非常简单,它只包含了 GetIssues 方法的三种重载。每种重载方法都会接受 IDocument 参数,其中包含了所有与正在处理的文件相关的信息,包括原始文本、语法树、语义模型以及指向所包含项目的反向引用。其中还包含了一个取消令牌(cancellation token),以防备 IDE 需要取消分析操作,原因可能是因为用户对某个文件进行了编辑。

三种重载方法还会接受三种语法类型中的一种: 节点(node)、令牌(token)或者琐碎内容(trivia)。大多数分析工作都是在节点级别上完成的。琐碎内容代表的是编译器不需要的信息,像空格、注释以及缺少上下文的令牌。另一方面,节点表示的内容很广泛,从最顶级的命名空间声明,一直到最小的表达式都可以表示。

当检测到错误的时候,它就会以 CodeIssue 列表的形式返回给 IDE。CodeIssue 中会包含严重等级(信息、警告还是错误)、表示错误发生位置的 Span 对象以及对错误的描述。

快速修正

代码问题报告中可能还包含一个或多个 ICodeAction 对象。这些对象让开发者可以提供自动修正的选择,就像下图所显示的这样。

创建 ICodeAction 并与 ICodeActionEdit 匹配要比创建代码问题报告困难得多。我们需要学习如何编辑语法树,并通过 IWorkstation 接口来发布所做的变更。Roslyn 站点上提供了编写快速修正的简单教程

代码重构

对代码重构的支持看起来和修正代码问题的“快速修正”功能很类似,但是它应用于文本级别。使用ICodeRefactoringProvider 的时候要提供一个文档和TextSpan 对象,并且要返回CodeRefactoring 对象。这个对象只是包含了ICodeAction 对象的集合,就像上面所讨论的CodeIssue 对象一样。

为代码重构所提供的项目模板中并没有包含可用的演示程序,但是在此我们可以使用快速修正教程中所展示的相同技术。

自动完成提供程序

ICompletionProvider 接口中仅有一个叫做 GetItems 的方法。它会接受一个 IDocument 类型的参数和一个整型的 position 参数。并返回 CompletionItem 的列表。每个 CompletionItem 都需要提供要显示的文本。开发者可能还会在其中包含图标、描述和(或)要插入的替换文本。(对于 insertionText,如何不提供的话,默认就是要显示的文本。)

尽管它不像其它提供程序那样有用,但是我们还是可以做一些有趣的操作,像构建对于一般的代码片段结构过于复杂的模板等。

大纲视图

最后一个项目模板是语法大纲视图(Syntax Outliner),这是通过 ISyntaxOutliner 接口暴露出来的。我们可以使用它在文本编辑器中创建可折叠的大纲视图,就像我们可以折叠区域、类和方法一样。接口会接受一个语法节点(Syntax node)作为参数,并要返回一个 OutliningSpan 对象列表,其中每个对象都拥有所要包含的 TextSpan、HintSpan(用于鼠标悬停时显示文本)、标题文本以及自动折叠的选项。

查看英文原文: Building Visual Studio Extensions with Roslyn

2011-11-05 23:392189
用户头像

发布了 340 篇内容, 共 129.0 次阅读, 收获喜欢 13 次。

关注

评论

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

ziliqa生态打造区块链技术实体应用新标杆

极客编

Cassandra集群架构及算法剖析

老任物联网杂谈

大数据 分布式 Cassandra 时序数据库

手把手透析C语言堆内存申请malloc及扩容realloc

卓丁

c 堆内存管理 heap memory malloc realloc

绿宝这条宝藏街,夜宵也太太太太太好吃了吧!

极客编

python实现·十大排序算法之归并排序(Merge Sort)

南风以南

Python 排序算法 归并排序

ARTS第一周

困到清醒

ARTS 打卡计划 起跑

ARTS打卡第一周

Tom

Refcard,近300份技术大咖总结的cheat sheet

KAMI

学习 开发 分享 作弊卡

JUC整理笔记二之聊聊volatile

JFound

列个清单-《清单革命》

Jack Hong

Implement Stack using Queues

onee

LeetCode

人工智能学习心得--人工智能分类

岛乾坤

AI

最优组合问题-贪心算法

Geek_k6ry2n

Spring事务@Transactional底层原理

Geek_k6ry2n

spring 事务 hiber

思考:如何打造一个优秀的研发体系?

菜根老谭

研发管理 研发效能 研发体系

ARTS 打卡 WEEK1

编程之心

ARTS 打卡计划

ARTS打卡第一周

落曦

重学 Java 设计模式:实战抽象工厂模式

小傅哥

设计模式 小傅哥 重构 代码质量 代码坏味道

DDD 中的那些模式 — CQRS

Joshua

领域驱动设计 DDD 事件驱动 CQRS Event Driven

20200518-20200524朋友圈思考汇总

罗小布

日常思考

程序员的晚餐 | 5 月 24 日 咖喱鸡块

清远

美食

利用树形结构辅助实现去重算法

卓丁

算法 algorithm tree Deduplication

从 Node 到 Deno

寇云

node.js deno

理解这八大优势,才算精通单元测试

禅道项目管理

测试 单元测试

Rust 遇上 C/C++ (一):数组操作

Coding Fatty

c c++ rust 编程语言

回“疫”录(24):开始了就不算晚

小天同学

疫情 个人成长 回忆录 个人感想 日常思考

在线文档的开发难度与突破

葡萄城技术团队

分布式协同 SpreadJS 在线文档

从零到部署:用 Vue 和 Express 实现迷你全栈电商应用(二)

图雀社区

node.js vue.js Vue

学会推销自己

一尘观世界

创业 程序员 外包 销售 接项目

别在发愁写页面了,强烈推荐几款傻瓜式扒网站神器!!

公众号:V5codings

坚持ARTS(week-1)

王钰淇

ARTS 打卡计划

使用Roslyn构建Visual Studio扩展_.NET_Jonathan Allen_InfoQ精选文章