如何扩展VisualStudio编辑器

TskComment 文件中主要有两种方法： 构造函数 和 onSizeChange 方法。在构造函数中，由 Brush 绘制一个紫色矩形并将其绑定到编辑器视图 onSizeChange 方法。

1 Brush brush = new SolidColorBrush(Colors.BlueViolet); 2 brush.Freeze(); 3 Brush penBrush = new SolidColorBrush(Colors.Red); 4 penBrush.Freeze(); 5 Pen pen = new Pen(penBrush, 0.5); 6 pen.Freeze(); 7
8 //draw a square with the created brush and pen 9 System.Windows.Rect r = new System.Windows.Rect(0, 0, 30, 30); 10 Geometry g = new RectangleGeometry(r); 11 GeometryDrawing drawing = new GeometryDrawing(brush, pen, g); 12 drawing.Freeze(); 13
14 DrawingImage drawingImage = new DrawingImage(drawing); 15 drawingImage.Freeze(); 16
17 _image = new Image(); 18 _image.Source = drawingImage;

上面的代码创建一个紫色矩形。如果你不理解它，没关系，因为这部分代码需要删除。

onSizeChange 中调用了 AddAdornment 此方法向编辑器添加一个紫色矩形。

1 public void onSizeChange() 2 { 3 //clear the adornment layer of previous adornments 4 _adornmentLayer.RemoveAllAdornments(); 5
6 //Place the image in the top right hand corner of the Viewport 7 Canvas.SetLeft(_image, _view.ViewportRight - 60); 8 Canvas.SetTop(_image, _view.ViewportTop + 30); 9
10 //add the image to the adornment layer and make it relative to the viewport 11 _adornmentLayer.AddAdornment(AdornmentPositioningBehavior.ViewportRelative, null, null, _image, null); 12 }

到目前为止，原理部分已经解释过。信不信由你，你可以通过以下方式修改它 TskComment 我们已经使用这两种方法实现了我们自己的扩展。

添加控件和基本代码

如何实现我想要的功能？

首先，我们的工具需要一个交互式界面，不能简单地使用 Brush 画。因此，需要创建一个新的 WPF 控制（不能 Winform 控件，AddAdornment 只能接受 WPF 元素）。

图14 新建 WPF 用户控件

按照 MVVM 按顺序添加想法 DelegateCommand、ViewModelBase、MainViewModel 这些文件，我们所有的核心逻辑都在于 MainViewModel 中。

图15 新添加的文件

MainWindow.xaml 中的代码如下（省略了一些与逻辑无关的元素）。

1 <UserControl x:Class="TskComment.MainControl" 2 ... 3 d:DesignHeight="41" Width="300"> 4 5 </local:MainViewModel> 6 </UserControl.DataContext> 7
8 9 10 11 12 13 14 15 16

MainViewModel 中的代码如下（省略一些不相关的代码），其中 MoveToTopOrBottomOfBlock 和 Execute 由于缺少关键元素，这两种方法的代码都暂时为空。

1 #region Properties and Fields 2
3 private ObservableCollection _cmtCollection = new ObservableCollection(); 4 public ObservableCollection CMTCollection 5 { 6 get { return _cmtCollection; } 7 set { _cmtCollection = value; RaisePropertyChanged("CMTCollection"); } 8 } 9
10 private BaseComment selectedItem = null; 11 public BaseComment SelectedItem 12 { 13 get { return selectedItem; } 14 set { selectedItem = value; RaisePropertyChanged("SelectedItem"); } 15 } 16
17 public DelegateCommand MoveToTopOfBlockCmd { get; set; } 18 public DelegateCommand MoveToBottomOfBlockCmd { get; set; } 19 public DelegateCommand ExecuteCmd { get; set; } 20
21 #endregion 22
23 #region ctor 24
25 public MainViewModel() 26 { 27 MoveToTopOfBlockCmd = new DelegateCommand((o) => MoveToTopOrBottomOfBlock(true)); 28 MoveToBottomOfBlockCmd = new DelegateCommand((o) => MoveToTopOrBottomOfBlock(false)); 29 ExecuteCmd = new DelegateCommand((o) => Comment()); 30 } 31
32 #endregion 33
34 #region Methods 35
36 private void MoveToTopOrBottomOfBlock(bool up) 37 { 38 //... 缺少关键元素 39 } 40
41 private void Comment() 42 { 43 //... 缺少关键元素 44 } 45
46 #endregion

获取DTE对象

上一节中缺少的关键元素实际上是DTE此对象等效于 Visual Studio 可以通过操作此实例来控制编辑器中的内容（如果想进一步了解，请参考 参考资源[1] ）例如，剪切、粘贴、创建新行、跳转到方法主体等。因此，如果要实现我前面提到的工具，则需要依赖此对象。

在宏编辑器中，获取对象很容易，但这里有点麻烦。我们必须依靠 Visual Studio 产品之一(Export) -- SVsServiceProvider。该产品的 GetService 可以获取此对象。

修改 TskCommentFactory 代码如下：

1 internal sealed class TskCommentFactory : IWpfTextViewCreationListener 2 { 3 [Import] 4 internal SVsServiceProvider ServiceProvider = null; //<-- 通过使用此代码，您可以获得 Visual Studio 的产物 5
6 //省略无关代码 7
8 public void TextViewCreated(IWpfTextView textView) 9 { 10 DTE dte = (DTE)ServiceProvider.GetService(typeof(DTE)); //<-- 获取DTE对象 11 new TskComment(textView, dte); //<-- 把dte传给 view 12 } 13
14 }

注：DTE 存在于 EnvDTE.dll 集会 SVsServiceProvider 存在于 Microsoft.VisualStudio.Shell.Immutable.10.0.dll 程序集，您需要先将这些程序集添加到项目中

完整的功能逻辑

现在我们已经获得了关键元素，我们将 MainViewModel 让我们改进代码。

1 private void MoveToTopOrBottomOfBlock(bool up) 2 { 3 if (DTE == null) 4 { 5 return; 6 } 7
8 CodeFunction func = Selection.ActivePoint.CodeElement[vsCMElement.vsCMElementFunction] as CodeFunction; 9
10 if (func != null) 11 { 12 if (up) 13 { 14 Selection.MoveToPoint(func.StartPoint); 15 } 16 else 17 { 18 Selection.MoveToPoint(func.EndPoint); 19 } 20 } 21 } 22
23 private void Comment() 24 { 25 Selection.StartOfLine(); 26 Selection.NewLine(); 27 Selection.LineUp(); 28 Selection.Text = "//TODO:"; 29 DTE.ExecuteCommand("Edit.FormatSelection"); 30 }

修改 MainWindow 代码允许它接受 DTE。

1 public partial class MainWindow : UserControl 2 { 3 public MainWindow(DTE dte) 4 { 5 InitializeComponent(); 6 ((MainViewModel)this.DataContext).DTE = dte; 7 } 8 }

修改 TskComment.cs 相应部分在

1 private MainWindow _win; 2
3 //... 省略一些代码 4
5 public TskComment(IWpfTextView view,DTE dte) 6 { 7 _win = new MainWindow(dte); 8
9 //... 10 } 11
12 public void onSizeChange() 13 { 14 //... 15
16 Canvas.SetLeft(_win, _view.ViewportRight - 310); //<-- 调整位置 17 Canvas.SetTop(_win, _view.ViewportTop + 90); //<-- 调整位置 18
19 _adornmentLayer.AddAdornment(AdornmentPositioningBehavior.ViewportRelative, null, null, _win, null); //<-- 把 win 把它放在界面上 20 }

哦，现在它可以运行了！

图16 动画演示

添加扩展点以启用注释以支持以后的扩展

上面的代码已经完成，但不幸的是这个评论太不人道了。如果我想添加一个 Phase0 评论或 FixMe 您需要修改代码才能提供注释。因此，这里也遵循 MEF 这个想法是升级代码。

在这里，只会解释和解释密钥代码。其他部分请参考童鞋的源代码。

新建 “协议” 项目

添加一个独立的项目来存储协议接口，并提供一个基于该接口的抽象类。

1 public interface IComment 2 { 3 string Title { get; } 4 string Description { get; } 5 void Execute(DTE dte); // 把DTE提供给第三方，以便他们可以使用它来操纵编辑器 6 } 7
8 public abstract class BaseComment:IComment 9 { 10 public abstract string Title{get;} 11
12 public abstract string Description{get;} 13
14 public abstract void Execute(DTE dte); 15
16 public override string ToString() 17 { 18 return Title; 19 } 20
21 protected TextSelection Selection(DTE dte) 22 { 23 return dte.ActiveDocument.Selection; 24 } 25
26 protected CodeFunction Function(DTE dte) 27 { 28 return Selection(dte).ActivePoint.CodeElement[vsCMElement.vsCMElementFunction] as CodeFunction; 29 } 30 }

新建 收件人

使用协议，我们应该在我们的工具中添加一个接收器来制作它 MEF 帮助我们将第三方产品与收件人相结合。

修改 MainViewModel, 添加收件人，因为可能有多个评论，因此请使用 ImportMany。

[ImportMany(typeof(BaseComment))]
public IEnumerable Comments;

新建 组合引擎

1 private void Init() 2 { 3 //设置目录 4 var catalog = new AggregateCatalog(); 5 catalog.Catalogs.Add(new DirectoryCatalog("D:\plugin\")); 6
7 _container = new CompositionContainer(catalog); 8 try 9 { 10 this._container.ComposeParts(this); 11 } 12 catch (CompositionException compositionException) 13 { 14 Console.WriteLine(compositionException.ToString()); 15 } 16
17 //将新注释绑定到集合，以便它可以显示在界面上 18 foreach (BaseComment itm in Comments) 19 { 20 CMTCollection.Add(itm); 21 } 22
23 if (Comments != null && Comments.Count() > 0) 24 { 25 SelectedItem = CMTCollection[0]; 26 } 27 }

大获成功。如果你还能跟上我的步伐，恭喜你。你基本上已经掌握了它 MEF 的想法和扩展 Editor 你的能力提高了。

Why VSPackages or MEF ?

换句话说 为什么宏和Add-in不再支持 谷歌肯定有很多答案，但考虑到文章的完整性，我仍然打算做搬运工。

根据Microsoft使用情况跟踪数据已完成，Visual Studio中宏的用户数量少于开发者总数1%。这还不足以使Microsoft放弃此功能，Visual Studio宏功能的高维护成本是另一个原因。与其他功能不同，对宏的支持必须附带Visual Studio每个新版本都会更新，并完成许多令人筋疲力尽的测试。从理论上讲，用户应该能够使用宏IDE录制并播放任何功能，这给微软的维护增加了巨大的负担。 Matt Kaufman说：宏IDE多个版本尚未更新。用户启动后，它很快就会看起来像旧版本Visual Studio。更麻烦的是，它只支持Visual Basic。用户无法使用C#或其他新的.NET语言来创建宏。

--- Visual Studio 11抛弃宏

微软已经放弃了Visual Studio附加组件是基础设施。根据MSDN上述声明”Visual Studio 2013丢弃的附加组件。开发人员应将附加组件升级到VSPackage展开 后来的文件表明”VSPackage是Visual Studio的主要体系结构单元也是部署、许可和安全的单元。Visual Studio大部分本身都写成VSPackage集合。”

--- Visual Studio 2013放弃加载项

源代码管理

CodePlex: Visual Studio Editor Extension -- TaskComment

TskComment.vsix: 您也可以直接点击 这里 获取此扩展并将其安装在您的 Visual Studio 当中。

参考资源

[1] 《Visual Studio 宏的高级用法

[2] Managed Extensibility Framework (MEF)

[3] Extending the Editor

本文来源于： 如何扩展 Visual Studio 编辑器》

作者： stg609

本文版权归作者和博客所有。欢迎转载，但未经作者同意，必须保留此声明，且原文连接必须在文章页面的显著位置提供。否则，保留追究法律责任的权利。

版权声明

所有资源都来源于爬虫采集,如有侵权请联系我们,我们将立即删除