一分钟搞定类头注释

来源:互联网 发布:昂立网络教育 编辑:程序博客网 时间:2024/06/06 08:26

         越到后面发现我们的学习逐步职业化,就拿注释来说,良好的注释说明有助于他人对程序的理解和后期的维护,在ITOO中更多的接触都是类里面方法或变量等的注释,前几天验收下期机房合作,发现一个良好的注释风格给人的印象和感受真的不一样。最近自己也在ITOO中重新搭框架,里面需要自己添加很多类,之前在项目中都是把头注释放在工具箱中,使用时候直接拖拽,当然这也是其中之一。这次想到之前自己在机房的时候也用到过一种方法,直接在安装路径中修改新建类的模板。因为类头注释里面的内容多,而且每个类或窗体里面的头注释内容大多相似,所以每次新建一个类或窗体的时候都要复制粘贴(当然还得稍微修改一下)?现在好了可以让VS自动生成头注释。网上也有很多这方面文章,可谓站在巨人肩膀上。

如何设置类头注释模板?

  1、打开VS2012的安装目录,找到Common7文件夹,接着打开D:\VS\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class,找到Class.cs文件并且以记事本方式打开,在其中加入你想要的模板。

/**********************************************************************************     * 开发人:李立平     * 开发组:王静娜、杨晨光、张子杰     * 类说明:      * 开发时间:$time$     * 开发版本:V4.0.0    **********************************************************************************/using System;using System.Collections.Generic;$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;$endif$using System.Text;$if$ ($targetframeworkversion$ >= 4.5)using System.Threading.Tasks;$endif$namespace $rootnamespace${    class $safeitemrootname$    {    }}

2、然后打开VS2012,新建一个类试一下效果:果然,新建类时VS就会自动生成 头文件注释了。


        当然还有一些接口、WebClass等标头的设置,还有其他语言的设置,磨刀不误砍柴工,工欲善其事必先利其器说的都是这个道理。

0 0
原创粉丝点击