经常在系代码的时候需要用到注释,现对自动注释做一个总结。
一、在新建一个类或form或别的文件时,在文件头自动添加文件信息:
1、打开 安装目录:\Program Files (x86)\Microsoft Visual Studio 9.0\Common7\IDE\ItemTemplatesCache文件夹。如下图:
2、按你使用的语言进入相应的文件夹。
3、按你想要添加注释的文件类型进入相应文件夹。比如:Windows Forms。然后进入1033文件夹。
4、进入Form.zip文件夹,打开Form.cs文件。
5、在文件的开始处添加如下代码:
//======================================================================
//
// Copyright (C) 2012-2013 公司名
// All rights reserved
//
// CLR Version: $clrversion$
// NameSpace: $rootnamespace$
// FileName: $safeitemrootname$
// Description :
//
// Created by 作者 at $time$
// Email : 邮箱
//
//======================================================================
6、保存文件即可。
7、最终界面效果:
二、针对函数进行注释。
效果图如下:
1、打开Visual Studio 2008(2005一样适用)开发工具,单击“工具→宏→新建宏项目”,然后按照步骤建立注释宏,添加如下代码并保存。
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
2、可以在Macro Explorer选项卡中使用该宏,也可以创建快捷键使用。
3、创建快捷键方法:打开 菜单 –> 工具–>选项 –> 键盘 ,在列表框中选择刚才添加的Macro,然后在 按快捷键中输入快捷键,点击”分配” 。