VS 自动注释

来自:http://blog.csdn.net/chanyinhelv/article/details/8447302

经常在系代码的时候需要用到注释，现对自动注释做一个总结。

 

一、在新建一个类或form或别的文件时，在文件头自动添加文件信息：

1、打开 安装目录:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\IDE\ItemTemplatesCache文件夹。如下图：

2、按你使用的语言进入相应的文件夹。

3、按你想要添加注释的文件类型进入相应文件夹。比如：Windows Forms。然后进入1033文件夹。

4、进入Form.zip文件夹，打开Form.cs文件。

5、在文件的开始处添加如下代码：

 

<span style="font-size:18px;">//======================================================================
//
//        Copyright (C) 2012-2013 公司名
//        All rights reserved
//
//        CLR Version: $clrversion$
//        NameSpace: $rootnamespace$
//        FileName: $safeitemrootname$
//        Description :
//
//        Created by 作者 at  $time$
//        Email : 邮箱
//
//======================================================================</span>

6、保存文件即可。

 方法2：

     写代码经常会要写一些版权信息、或者一些常用的命名空间引用，如果每个页面都拷贝粘贴一遍，确实挺麻烦的。有什么可以让我们一劳永逸的办法呢？vs中的模板功能来可以帮助我们达到这个目的。

     解决办法：   直接把D:\Program Files\Microsoft Visual Studio 8\Common7\IDE\ItemTemplates文件夹中的相应的模板压缩包Copy到C盘的My Documents\Visual Studio 2005\Templates中的相应位置，然后修改添加上自己要添加的信息。 然后在添加新项的时候选择“我的模板”下面的项即可。（http://www.cnblogs.com/xiachufeng/archive/2009/12/26/1632868.html）

二、针对函数进行注释。

效果图如下：

1、打开Visual Studio 2008(2005一样适用)开发工具，单击“工具→宏→新建宏项目”，然后按照步骤建立注释宏，添加如下代码并保存。

 

<span style="font-size:18px;">Sub AddFunComment()
Dim DocSel As EnvDTE.TextSelection
DocSel = DTE.ActiveDocument.Selection
DocSel.NewLine()
DocSel.Text ="/*******************************************************************"
DocSel.NewLine()
DocSel.Text ="* 函数名称："
DocSel.NewLine()
DocSel.Text ="* 功 能："
DocSel.NewLine()
DocSel.Text ="* 参 数："
DocSel.NewLine()
DocSel.Text ="* 返 回 值："
DocSel.NewLine()
DocSel.Text ="* 作 者： ZYD"
DocSel.NewLine()
DocSel.Text ="* 博 客： www.baidu.com"
DocSel.NewLine()
DocSel.Text ="* 电子邮箱："
DocSel.NewLine()
DocSel.Text ="* 日 期："+ System.DateTime.Now.ToLongDateString()
DocSel.NewLine()
DocSel.Text ="*******************************************************************/"
End Sub</span>

2、可以在Macro Explorer选项卡中使用该宏，也可以创建快捷键使用。

 

3、创建快捷键方法：打开 菜单 –> 工具–>选项 –> 键盘 ，在列表框中选择刚才添加的Macro，然后在 按快捷键中输入快捷键，点击”分配” 。