[置顶] 【VB.NET】如何自动生成类头注释

       最近在机房重构遇到了很多的问题，同时也看了师哥师姐的博客，发现好多师哥师姐的类前面都有注释，当时在想如果每个类都是这么敲上去得多麻烦啊，所以就果断百度了一下，确实有不少相关的博客。所以这里对如何为自动生成类头注释做一下详细的介绍。

      1、头文件注释的要求：

       注释中必须添加的内容有：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

          类头模板

 Public Class $safeitemname$
'**********************************************
'文件名：$safeitemname$
'命名空间：$rootnamespace$
'内容：
'功能：
'文件关系：
'作者：李晓东
'小组：
'生成日期：$time$
'版本号：V1.0.0.0
'修改日志：
'版权说明：
'**********************************************
End Class

     如何添加模板：

1、打开VS属性，打开文件位置

2、找到下图的路径

3、以记事本的方式打开，并且把类头模板复制到记事本里。

4、展示

下面的表格来说一下注释模板里的参数：

         最后普及一下代码注释的重要意义

        注释是程序员之间交流的通道。我们在欣赏古诗词的时候，难免也会遇上一些抽象难懂的字、词、句，然而，书本一般都带有注释，这是为了让读者更好地去想象创作时的场景，更好地去理解创作者的思想感情，然后设身处地陶醉一番。读者自然不吝赞美之词。我一直认为，代码如诗，写代码就好比吟诗作对。但是单纯的代码并不能完全使得程序的思想被其他人所理解，更有甚者，还会被咒骂。代码中的某些参数，就像上文提及的“字”；代码中的某些行，就像上文提及的“词”；代码中的某些函数或者某些代码块，就像上文提及的“句”。有了注释辅助，读者可以自行理解代码的实现思想，就不必手足无措地找人询问，大大节省时间成本，也可更专注在工作上。

       下面是我百度了一下不写注释的后果

       

       所以，为了我们的生命我们得写好注释啊！！！

        

小结：只要想了就要去做，任何让你提高效率的事情都不能错过。