chiaovincent

导航

打造自己的CodeSnippet,将自己的代码自动添加版权信息

vs2005的codesnippet功能可以减少重复操作,提高编程效率,这里以向代码添加版权信息为例介绍如何手工编写自己的codesnippet。
 1<?xml version="1.0" encoding="utf-8"?>
 2<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
 3  <CodeSnippet Format="1.0.0">
 4    <Header>
 5      <Title>版权信息说明</Title>
 6      <Shortcut>mycopyright</Shortcut>
 7      <Description>软件版权信息说明</Description>
 8      <Author>vincent</Author>
 9      <SnippetTypes>
10        <SnippetType>Expansion</SnippetType>
11      </SnippetTypes>
12    </Header>
13    <Snippet>
14      <Declarations>
15        <Literal Editable="true">
16          <ID>FileName</ID>
17          <ToolTip>文件名</ToolTip>
18          <Default>filename</Default>
19          <Function>
20          </Function>
21        </Literal>
22        <Literal Editable="true">
23          <ID>Description</ID>
24          <ToolTip>description</ToolTip>
25          <Default></Default>
26          <Function>
27          </Function>
28        </Literal>
29        <Literal Editable="true">
30          <ID>UserName</ID>
31          <ToolTip>UserName</ToolTip>
32          <Default>Vincent</Default>
33          <Function>
34          </Function>
35        </Literal>
36        <Literal Editable="true">
37          <ID>CreateDate</ID>
38          <ToolTip>CreateDate</ToolTip>
39          <Default>
40          </Default>
41          <Function></Function>
42        </Literal>
43      </Declarations>
44      <Code Language="csharp">
45        <![CDATA[//======================================================================
46//
47//        Copyright (C) 2007-2008 版权所有    
48//               All rights reserved
49//
50//        文件名 :$FileName$
51//        描述 :$Description$
52//
53//        Created by $UserName$ at  $CreateDate$
54//        
55//
56//======================================================================]]>
57      </Code>
58    </Snippet>
59  </CodeSnippet>
60</CodeSnippets>

文件解释

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#

codesnippetmanager

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

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

引用自:http://hi.baidu.com/simadi/blog/item/ee1d3b878ffa182ec75cc3f9.html

给代码添加版权信息的其它方法请查看

http://www.cnblogs.com/houleixx/archive/2008/03/09/1097740.html


posted on 2008-03-15 15:01  chiaovincent  阅读(261)  评论(0)    收藏  举报