VS中如何快捷地给自己的代码添加创建信息注释
Intro
以下讨论的都是没有使用 GIT 来管理源代码的情况，如果使用 GIT 管理源代码可直接使用VS的Git扩展就不需要考虑以下问题。
-
什么是创建信息注释？
创建信息注释，类似于文件的创建信息，一般来说，至少要有创建人和创建时间。如果说有人修改了方法也应该添加一个更新信息注释。
-
为什么要添加创建信息注释？
可能在一个人编码的时候，创建信息注释并不太重要，但是如果许多人共同维护一个项目，并且经常会出现多个人修改同一个文件的代码 时，这就显得很重要了，哪里的代码出现了什么问题，可以直接责任到人，谁改的代码出现了问题就应该谁去修改代码。
创建信息注释
-
找解决方案 最初的想法是重写 VS 内置的文档注释，然而并没有找到这样的解决方案。找到的基本都是修改新建类或接口时模板文件从而添加注释，并没有在方法上加注释 的解决方案。
-
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>cm</ 6 Shortcut 7 Description>新建代码注释 的代码片段 8 Author>liweihan 9 SnippetTypes10 SnippetType>Expansion11 12 13 Snippet14 Declarations15 Literal16 ID>Description17 ToolTip>方法描述18 Default19 20 21 >Author22 >作者23 24 25 26 >CreateDate27 >日期28 >@@Today29 30 31 Code Language="csharp"32 <![CDATA[/// <summary> 33 /// $Description$ 34 /// @Author:$Author$ 35 /// @CreateDate:$CreateDate$$end$ 36 /// </summary>]]> 37 Code38 39 CodeSnippet40 CodeSnippets>
这样的代码段还有许多不足，现在作者是写死的，创建时间需要再插入代码段之后再进行手动修改， 我希望能够自动生成作者和当前日期， 作者写死的问题不大，因为这个代码段只我一个人使用，直接写死反而更方便，这里使用一个变量方便进行修改， 关键是当前日期没有办法获取到，查阅了很多资料，代码段并不支持直接插入当前日期，stackoverflow 上有人讨论过这个问题，解决方案是利用宏自动生成当前日期，但是文中提到的解决方案不可用，不过倒给了我解决问题的思路——利用宏去插入当前日期。
-
宏插入当前日期 我在 VS 的 扩展与更新 中下载了一个 管理宏的插件—— Macros for Visual studio
下载安装之后需要重启 VS ，重启之后在 菜单栏中的工具下就可以看到：
这个宏管理器自带了一些 Samples ，其中有一个可以插入日期的宏
选择 Assign Shortcut 进行设置快捷键就可以在 VS 中使用啦，默认的格式是 “mm/dd/yyyy”
如果你像我一样不喜欢默认的日期格式，可以在对应项上右键选择“打开”，进行编辑，里面是 js 代码，有一些 js 基础的话修改起来会 更方便，我修改了下代码，将日期格式修改为了“yyyy-MM-dd”格式。
-
完整操作流程
更新信息注释
更新信息代码段示例：
1 2 3 4 5 >up 6 7 >更新代码注释 的代码片段 8 9 10 11 12 13 14 15 16 17 >更新描述18 19 20 21 >UpdatedBy22 >更新人23 24 25 26 >UpdatedDate27 28 29 30 31 32 /// $Description$ @UpdatedBy:$UpdatedBy$ @UpdatedDate:$UpdatedDate$$end$ 33 34 35 36 >
将自定义代码段添加到 VS
- 在 VS 中打开代码段管理器
