VS中如何快捷地给自己的代码添加创建信息注释

Intro

以下讨论的都是没有使用 GIT 来管理源代码的情况，如果使用 GIT 管理源代码可直接使用VS的Git扩展就不需要考虑以下问题。

1. 什么是创建信息注释？

   创建信息注释，类似于文件的创建信息，一般来说，至少要有创建人和创建时间。如果说有人修改了方法也应该添加一个更新信息注释。

2. 为什么要添加创建信息注释？

   可能在一个人编码的时候，创建信息注释并不太重要，但是如果许多人共同维护一个项目，并且经常会出现多个人修改同一个文件的代码 时，这就显得很重要了，哪里的代码出现了什么问题，可以直接责任到人，谁改的代码出现了问题就应该谁去修改代码。

创建信息注释

1. 找解决方案 最初的想法是重写 VS 内置的文档注释，然而并没有找到这样的解决方案。找到的基本都是修改新建类或接口时模板文件从而添加注释，并没有在方法上加注释 的解决方案。

   这个方案否定之后，尝试着使用自定义代码段来实现在生成注释的基础上再添加创建信息注释。

2. 自定义代码段

   自定义代码段参考示例：

    1     <??> 2     <CodeSnippets ="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 3       <CodeSnippet Format="1.0.0"> 4         <Header> 5           <Title>cm</Title> 6           <Shortcut>cm</Shortcut> 7           <Description>新建代码注释 的代码片段</Description> 8           <Author>liweihan</Author> 9           <SnippetTypes>10             <SnippetType>Expansion</SnippetType>11           </SnippetTypes>12         </Header>13         <Snippet>14           <Declarations>15             <Literal>16               <ID>Description</ID>17               <ToolTip>方法描述</ToolTip>18               <Default>方法描述</Default>19             </Literal>20             <Literal>21               <ID>Author</ID>22               <ToolTip>作者</ToolTip>23               <Default>liweihan</Default>24             </Literal>25             <Literal>26               <ID>CreateDate</ID>27               <ToolTip>日期</ToolTip>28               <Default>@@Today</Default>29             </Literal>30           </Declarations>31           <Code Language="csharp">32           <![CDATA[/// <summary>33           /// $Description$34           /// @Author:$Author$35           /// @CreateDate:$CreateDate$$end$36           /// </summary>]]>37           </Code>38         </Snippet>39       </CodeSnippet>40     </CodeSnippets>

   
   

    

   海外公司注册、海外银行开户、跨境平台代入驻、VAT、EPR等知识和在线办理：https://www.xlkjsw.com

   

   原标题：VS中如何快捷地给自己的代码添加创建信息注释

   关键词：