工欲善其事必先利其器，而 Visual Studio 就是我们的开发利器。

上一篇文章，介绍了一个很简单的方式去 制作代码片段(Code Snippet)，对于编写代码本身，也是可以进行封装与重用的。

这篇文章，推荐两个自动生成注释的 开源轻量级 Visual Studio 插件。

1. 前言

在开发的过程中，写注释也是一个很好的习惯，这些注释不仅仅对其他开发者有帮助，对自己也是有帮助的。

因为在若干月之后，可能就不知道当初的某一个方法，属性到底在做什么，有什么需要注意的地方。

很多公司也会基于这些注释 来生成代码文档用于查阅与交付。也如Swagger框架 在生成测试接口时，也可以将注释一并展示。

2. 介绍

以下插件都是通过 快速操作(Quick Action) 来完成，快捷键为 (Alt+Enter or Ctrl+.)。

他们的本质为拓展 VS 的 代码分析器(code analyzer) 和 代码修补(code fix)。

1. Pull Through Documentation

此插件适用于 有父类或者接口的情况，可以从父类的相同成员中，抽取其注释到子类的相同成员中。

举例：

有一个接口为

interface IMyInterface 
{
    /// <summary>
    /// This method does something
    /// </summary>
    void DoSomething();
}

有一个子类为

class MyClass : IMyInterface
{
    public void DoSomething();
}

通过代码抽取：

下载地址：Pull Through Documentation - Visual Studio Marketplace

github地址：PullThroughDoc - github

支持的 VS版本： 2017，2019

2. DocumentationAssistant

此插件适用于任何情况，能够根据成员的结构信息来生成注释。

实操展示- 借助于鼠标

：

实操展示- 借助于快捷键（Alt+Enter or Ctrl+.)

下载地址：DocumentationAssistant - Visual Studio Marketplace

github地址：DocumentationAssistant - github 

支持的 VS版本： 2017，2019

3. 总结

这两个插件可以极大的缩短写注释所需要的时间，使开发者更聚焦于代码本身。

对于大部分简单的成员（类，字段，属性，方法等），如果命名良好的话可以直接生成，而对于需要详细解释的，可以基于生成的注释来补充，效率会更高。