【牛腩】——如何为类文件自动添加头注释？

前言

论如何写出优秀的代码注释？

写代码和注释的第一目的是帮助人理解代码，理解作者的意图。所以优秀的代码本身就有自说明的功能，但是在代码本身无法阐述作者意图时，需要考虑写注释，注释也是为了为后继开发者以及代码维护者提供了方便。我们知道，写代码要写注释，甚至听说代码的20%是注释，然后我们就认真对待写注释，后来看书多了，了解了敏捷开发，知道了好的代码是不需要注释这么一说的，当然，好的代码本身就是注释，这话是对的，但是我觉得这仅局限于逻辑简单直白的代码，如果没有注释我相信看代码的人是要花很多时间精力去理解的，不管你的代码写的有多好都是如此。逻辑复杂的代码，写注释是很有必要的，注释怎么写？对于实现来说，把自己写代码时怎么思考的用精简的语言写下来；对于接口来说，就像敏捷开发中提到的，代码接口本身就是注释，加注释是来描述这个接口在整个代码中是处于什么角色。

内容

有些注释是可以自动生成的，或者说自动生成注释是用来处理重复率高的注释，为了降低代码编写过程中的工作量，通常我们新建一个类时，会在类引用的命名空间前加注释来说明有关这个类模块的信息，那如何自动生成类文件前的头注释呢？

第一步：

打开VS2017的安装文件夹，按照如下路径打开，找到目标文件“ItemTemplates”

第二步：

打开我的文档，找到“Templates”文件夹下的目标文件“ItemTemplates”，将此文件夹复制到VS安装路径下找到的相同名字的文件中

第三步：

然后在VS安装路径下继续找到CSharp中的class，如下路径所示，选择“class”，右击选择“编辑”，在记事本中打开，将注释添加到类前，然后保存，一个注释模板就创建好了，每次重新添加类时，都会出现类的头注释。