chaoyue、

超悦廊坊师范学院七期信息技术提高班

日志

关于我

chaoyue、

文章分类

懒人懒法——VS自动添加类、函数注释、版权信息

2011-05-02 10:55:58| 分类：实践中的收获 | 标签： |举报 |字号大中小订阅

下载LOFTER 我的照片书 |

为了别人能在使用自己的代码时能够看懂,注释是必不可少的。格式一般是固定的,像类、函数的注释，还有版权信息，作者是谁谁啦，时间是什么时候。但是比起一行一行的写注释，懒人更愿意有个方便的方法，能减少这样的工作量。

所以，像我这种懒人呢，就找了能让自己省事的方法。这次接触的是宏脚本。

【VS宏脚本自动添加版权信息】

虽然我不怎么懂关于宏的东西，但从网上看到的VS2010的宏脚本是VBScript，比较容易懂，具体方法：

工具→宏→新建宏项目，输入文件名称，并选择要保存的位置

将下面的代码复制进去，保存。（vb的文件，注释符号用“ ' ”,c#或其他语言时改成相应的注释符号即可）

Imports System

Imports EnvDTE

Imports EnvDTE80

Imports EnvDTE90

Imports EnvDTE90a

Imports EnvDTE100

Imports System.Diagnostics

Public Module Module1

Sub AddNew()

Dim DocSel As EnvDTE.TextSelection

DocSel = DTE.ActiveDocument.Selection

DocSel.NewLine()

DocSel.Text = " '***********************************************************************"

DocSel.NewLine()

DocSel.Text = " '文件名称：" + DTE.ActiveDocument.Name

DocSel.NewLine()

DocSel.Text = " 'CLR 版本：" + DTE.Version

DocSel.NewLine()

DocSel.Text = " '描述："

DocSel.NewLine()

DocSel.Text = " '作者：ZengChaoyue "

DocSel.NewLine()

DocSel.Text = " '博客：（CSDN） http://blog.csdn.net/zengchaoyue/category/816108.aspx （网易） http://z.chao.yue.blog.163.com/"

DocSel.NewLine()

DocSel.Text = " '创建日期：" + System.DateTime.Now.ToString()

DocSel.NewLine()

DocSel.Text = " '修改人："

DocSel.NewLine()

DocSel.Text = " '修改日期："

DocSel.NewLine()

DocSel.Text = " '修改原因："

DocSel.NewLine()

DocSel.Text = "'***********************************************************************"

End Sub

End Module

【使用方法】

工具→选项→环境→键盘

在显示命令包含输入框里输入你刚刚新建的文件名，

如上图，我输入了文件的前三个字母，就找到了刚刚保存的文件AddNew

接下来，设置用来运行宏的快捷键，注意不要和已有的快捷键相冲突。

将光标定位在“按快捷键（P）”对应的输入框处，接下来，在键盘上按你想设置的快捷键。比如我想设Alt+N为快捷键，就按键盘上的AIt和N键，你会发现，输入框自动出现了“Alt+N”，点分配，最后确定，完成！

如图，

下面让我们来验证一下效果吧

随便新建了一个vb.net文件

打开代码编辑界面，按下设置好的快捷键（Alt+N），看效果

这样，懒人们以后就不用一行一行的添加头注释了。

当然，类、函数的注释也可以定义类似的模板，只要改一下宏脚本就可以了，这里就不放代码了。

想要修改宏脚本也很简单，工具→宏→宏IDE，找到你之前写的文件进行修改，并保存就好了。

评论这张

转发至微博

阅读(6623)| 评论(5)

历史上的今天

this.p={  m:2,
              b:2,
              loftPermalink:'',
              id:'fks_095067093086082069087082084095085085081075082084080065084',
              blogTitle:'懒人懒法——VS自动添加类、函数注释、版权信息',
              blogAbstract:'<STRONG\><FONT size=\"2\"  \>  </FONT\></STRONG\>  <P style=\"TEXT-INDENT: 2em;\"  \><STRONG\><FONT size=\"2\"  \>为了别人能在使用自己的代码时能够看懂,注释是必不可少的。格式一般是固定的,像类、函数的注释，还有版权信息，作者是谁谁啦，时间是什么时候。但是比起一行一行的写注释，懒人更愿意有个方便的方法，能减少这样的工作量。</FONT\></STRONG\></P\>  <P style=\"TEXT-INDENT: 2em;\"  \><STRONG\><FONT size=\"2\"  \>所以，像我这种懒人呢，就找了能让自己省事的方法。这次接触的是宏脚本。</FONT\></STRONG\></P\>  <P style=\"TEXT-INDENT: 2em;\"  \><STRONG\><FONT size=\"2\"  \> </FONT\></STRONG\></P\>  <P style=\"TEXT-INDENT: 2em;\"  \><STRONG\><FONT size=\"2\"  \>【VS宏脚本自动添加版权信息】</FONT\></STRONG\></P\>  <P style=\"TEXT-INDENT: 2em;\"  \><STRONG\><FONT size=\"2\"  \>虽然我不怎么懂关于宏的东西，但从网上看到的VS2010的宏脚本是VBScript，比较容易懂，具体方法：</FONT\></STRONG\></P\>',
              blogTag:'',
              blogUrl:'blog/static/13086262020114210373211',
              isPublished:1,
              istop:false,
              type:0,
              modifyTime:1316824685640,
              publishTime:1304304958868,
              permalink:'blog/static/13086262020114210373211',
              commentCount:5,
              mainCommentCount:4,
              recommendCount:0,
              bsrk:-100,
              publisherId:0,
              recomBlogHome:false,
              currentRecomBlog:false,
              attachmentsFileIds:[],
              vote:{},
              groupInfo:{},
              friendstatus:'none',
              followstatus:'unFollow',
              pubSucc:'',
              visitorProvince:'',
              visitorCity:'',
              visitorNewUser:false,
              postAddInfo:{},
              mset:'000',
              mcon:'',
              srk:-100,
              remindgoodnightblog:false,
              isBlackVisitor:false,
              isShowYodaoAd:true,
              hostIntro:'',
              hmcon:'1',
              selfRecomBlogCount:'0',
              lofter_single:'<iframe width="140" height="560" style="overflow:hidden;" src="http://www.lofter.com/mailEntry.do?blogad=1&blog" frameBorder="0"></iframe>'
            }

{list a as x}
    {if !!x}
    <div class="iblock nbw-fce nbw-f40">
      <a class="fc03 noul" target="_blank" hidefocus="true" href="http://blog.163.com/${x.visitorName}/">
      {if x.visitorName==visitor.userName}
      <img alt="${x.visitorNickname|escape}" onerror="this.src=location.f40" class="cwd bdwa bdc0" src="${fn1(x.visitorName)}&r=${visitor.imageUpdateTime}"/>
      {else}
      <img alt="${x.visitorNickname|escape}" onerror="this.src=location.f40" class="cwd bdwa bdc0" src="${fn1(x.visitorName)}"/>
      {/if}
      </a>
      <div class="cwd vname thide">
        {if x.moveFrom=='wap'}
          <a class="noul pnt" target="_blank" href="http://blog.163.com/services/wapblog.html?frompersonalbloghome"><span title="来自网易手机博客" class="iblock wapIcon"> </span></a>
        {elseif x.moveFrom=='iphone'}
          <a class="noul pnt" target="_blank"><span title="来自iPhone客户端" class="iblock iphoneIcon"> </span></a>
        {elseif x.moveFrom=='android'}
          <a class="noul pnt" target="_blank"><span title="来自Android客户端" class="iblock androidIcon"> </span></a>
        {elseif x.moveFrom=='mobile'}
          <a class="noul pnt" target="_blank" href="http://blog.163.com/services/emsblog.html?frompersonalbloghome"><span title="来自网易短信写博" class="iblock wapIcon"> </span></a>
        {/if}
        <a class="fc03 m2a"  target="_blank" hidefocus="true" href="http://blog.163.com/${x.visitorName}/">
          ${fn(x.visitorNickname,8)|escape}
        </a>
      </div>
    </div>
    {/if}
    {/list}

<#--最新日志，群博日志--> <#--推荐日志-->

<p class="fc06">推荐过这篇日志的人：</p>
    <div>
      {list a as x}
      {if !!x}
      <div class="iblock nbw-fce nbw-f40">
        <a class="fc03 noul" target="_blank" hidefocus="true" href="http://blog.163.com/${x.recommenderName}/">
        <img alt="${x.recommenderNickname|escape}" onerror="this.src=location.f40" class="cwd bdwa bdc0" src="${fn1(x.recommenderName)}"/>
        </a>
        <div class="cwd thide">
          <a class="fc03 m2a" target="_blank" hidefocus="true" href="http://blog.163.com/${x.recommenderName}/">
            ${fn(x.recommenderNickname,6)|escape}
          </a>
        </div>
      </div>
      {/if}
      {/list}
    </div>
    {if !!b&&b.length>0}
    <p  class="fc06">他们还推荐了：</p>
    <ul>
    {list b as y}
      {if !!y}
        <li class="rrb"><span class="iblock">·</span><a class="fc03 m2a" target="_blank" href="http://blog.163.com/${y.recommendBlogPermalink}/?from=blog/static/13086262020114210373211">${y.recommendBlogTitle|escape}</a></li>
      {/if}
    {/list}
    </ul>
    {/if}

<#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇，下一篇--> <#-- 热度 -->

{list a as x}
    {if !!x}
    <div class="hotItem iblock nbw-fce nbw-f40">
      <a class="fc03 noul" target="_blank" hidefocus="true" href="http://blog.163.com/${x.publisherUsername}/">
      {if x.publisherUsername==visitor.userName}
      <img alt="${x.publisherNickname|escape}" onerror="this.src=location.f40" class="cwd bdwa bdc0" src="${fn1(x.publisherUsername)}&r=${visitor.imageUpdateTime}"/>
      {else}
      <img alt="${x.publisherNickname|escape}" onerror="this.src=location.f40" class="cwd bdwa bdc0" src="${fn1(x.publisherUsername)}"/>
      {/if}
      </a>
      <div class="cwd vname thide">
        <a class="fc03 m2a"  target="_blank" hidefocus="true" href="http://blog.163.com/${x.publisherUsername}/">
          ${fn(x.publisherNickname,8)|escape}
        </a>
      </div>
      <a class="f-myLikeIcons hottype {if x.type==1} js-liketype{elseif x.type==2} js-reblogtype{elseif x.type==3} js-sharetype{else}{/if}" target="_blank" hidefocus="true" href="http://blog.163.com/${x.publisherUsername}/"> </a>
    </div>
    {/if}
    {/list}

<#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->

页脚

我的照片书 - 手机博客 - 下载LOFTER APP - 订阅此博客

chaoyue、

导航

日志

懒人懒法——VS自动添加类、函数注释、版权信息

历史上的今天

最近读者

热度

评论

页脚