VS2005 注释模板 快捷注释 注释快捷键

转载 2011年01月10日 09:42:00

通过一个简单例子,介绍两种添加CodeSnippet的方法,手动添加和用工具添加,最后再介绍一些常用的codesnippet

不少使用VisualStudio2005的coder,都对vs2005的codesnippet功能很熟悉,运用codesnippet可以减少许多烦琐的重复操作,提高编程效率,.net本身提供了丰富code snippet,但是,如果这些codesnippet不满足你的要求,嘿嘿,就自己创建一个吧

比如:假如公司的代码规范规定我们每个类的开头,都必须写上这样一段

///**************************

/// 创建者:yizhu

/// 创建日期:2007-7-4

///*************************

当然,不同用户创建的类要写不同的名字,所以创建者其实是个可编辑的变量,创建日期也一样,我们来把这个小注释块转化成一个codesnippet

方法一:手动添加

打开记事本,输入以下内容

 

<?xml version="1.0" encoding="utf-8"?>

<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">

  <CodeSnippet Format="1.0.0">

    <Header>

      <Title>创建注释</Title>

      <Shortcut>mycomm</Shortcut>

      <Description>创建俺用的代码注释</Description>

      <Author>yizhu2000</Author>

      <SnippetTypes>

        <SnippetType>Expansion</SnippetType>

      </SnippetTypes>

    </Header>

    <Snippet>

      <Declarations>

        <Literal Editable="true">

          <ID>UserName</ID>

          <ToolTip>UserName</ToolTip>

          <Default>yizhu</Default>

          <Function>

          </Function>

        </Literal>

        <Literal Editable="true">

          <ID>CreateDate</ID>

          <ToolTip>CreateDate</ToolTip>

          <Default>

          </Default>

          <Function></Function>

        </Literal>

      </Declarations>

      <Code Language="csharp"><![CDATA[///**************************

/// 创建者:$UserName$

/// 创建日期:$CreateDate$

///**************************]]></Code>

    </Snippet>

  </CodeSnippet>

</CodeSnippets>

 

这就是用来创建你的code snippet的xml文件

文件解释

CodeSinppet节点下面,有两重要的节点,Header,Snippet

  • Header标签下面主要放这一些描述信息,以及对快捷方式的定义,下面是具体的解释

 

<Title>:给你的codesnippet起个名字

<Description>:描述

<Author>:创建者

<Shortcut>:快捷键,就好像创建属性的prop,创建构造函数的ctor,这个比较重要了,要为你的codesnippet想一个好名字,记得不要和系统自己的codesnippet重名

<SnippetType>:可以选择两个值,Expansion和SurroundsWith

  • Snippet标签下面是变量的定义和具体code的定义我们定义了两个变量<Declaration>下面就是变量的申明我们声明了两个<Literal>型的变量,分别代表创建者和时间

 

<ID>:变量标识,就是变量名称,在下面我们要通过这个标识来引用这个变量

<ToolTip>:当鼠标指到这个变量的编辑区域上时,显示的提示信息

<Default>:默认值

<Function>:函数,我们可以用系统提供的一些方法来引用当前类名,或者根据参数创建switch代码的的case语句等等

<Code>:就是具体的code的定义,可以看到,这里用$ID$的方式来引用变量

 

保存并导入Visual Studio

把上面这个文件保存为一个后缀为.snippet的文件,然后在visual studio中导入它,具体做法是

在visual studio中通过Ctrl+K Ctrl+B打开Code Snippet Manager,为你的codesnippet选择应用的语言,这种注释只能在C#里用,所以是C#

Import...,选择你刚才保存的snippet文件,并把它导入到My Code Snippets分类下面

导入成功候你就可以看见在My Code Snippets下面有了刚才创建的code snippet

这个时候就大工告成了

看看效果

随便打开一个代码文件,键入mycomm(xml文件里面定义的快捷键),然后点击Tab键,^_^

代码产生了,大家现在可以用tab键在编辑区域间游走,并且编辑他们

方法二:运用工具

觉得手动添加麻烦的话可以去下个codesnippet编辑工具,叫Snippy

下载地址1

http://download.csdn.net/source/205118

官方下载地址

http://www.gotdotnet.com/codegallery/codegallery.aspx?id=b0813ae7-466a-43c2-b2ad-f87e4ee6bc39

编辑界面如图

 

创建之后保存和导入的过程同上

一些常用的codeSnippet

注意:很多人都问我怎么输入了快捷键没有反应,记住键入快捷方式后按Tab键,才能产生代码,

先介绍几个有用的CodeSnippet

常见

ctor:创建一个构造函数

class:创建类

interface:创建接口

using:using(resource){}

if:创建if(){}

try:创建try catch

else:创建else{}

do:do..while循环

prop:创建属性

propg:创建只有get的属性

switch:创建一个switch段,如果switch的条件是个枚举,那么他可以帮你产生所有的枚举值的case

不常见,也很有用

cw:创建Console.WrileLine

mbox:MessageBox.Show()

svm:void Main函数

#region:创建#region #endregion

#if:创建#if #endif

equals:创建Equals()方法的重载,并同时一个GetHashCode的方法

exception:创建一个从Exception继承的自定义的Exception

vs2005 为函数自动添加注释

a) 自动添加文件注释  效果如下: /* * Copyright(C) 2012,Company 保留所有权利。( All rights reserved. ) * * 文件名称:T...

vs2005 为函数自动添加注释

a) 自动添加文件注释  效果如下: [cpp] view plaincopy /*   * Copyright(C) 2012,Company 保留所有...

VS2005用VBA写的代码注释宏

原文地址: http://blog.csdn.net/leatinfy/archive/2010/03/14/5379095.aspx       代码注释有很多风格,纵多开源软件都使用doxy...

VS2005插件——文件头的注释

  • 2011年09月08日 13:58
  • 22KB
  • 下载

C/C++ VS2012及以上添加 Snippet,自定义快捷输入注释

一、这种东西有什么好处呢? 提高代码的规范性!关键中的关键哇 给后面代码的使用者提供思路或者联系 二、直接上使用方法 Anno就是我们自己定义的快捷输出 那如何实现它呢?研究了一会儿发现,可以这...

VS 2005 为函数自动添加注释

a) 自动添加文件注释  效果如下: [cpp] view plaincopy /*  * Copyright(C) 2012,Company 保留所有权利。( All rights res...

IntelliJ Idea 常用快捷键 及 模板注释

Ctrl+Alt+t 选择代码块 try catch Alt+回车 导入包,自动修正 Ctrl+N 查找类 Ctrl+Shift+N 查找文件 Ctrl+Alt+L 格式化代码 Ctr...

android studio 注释模板并设置快捷键

1、设置注释模板 ctrl + alt +s 调出设置面板,然后 Editor ----> File and Code Templates ,接着选右边的 Files ----> Class  ...

vs2010番茄助手快速添加注释+快捷键

官网讲解:http://www.wholetomato.com/products/features/vasnippets.asp 一个好的项目工程,注释是必不可少的,vc助手中有一个功能可以帮助我们...

设置VS2008 快捷键 快速注释

如你所愿--设置VS2008快捷键 最近在使用VS2008学习C++,因为之前使用matlab已经习惯了使用快捷键注释Ctrl+R, Ctrl+T,因此希望能够自定义快捷键. (1)选择【工具】>...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:VS2005 注释模板 快捷注释 注释快捷键
举报原因:
原因补充:

(最多只允许输入30个字)