Enable Visual Studio to automatically add header comments

In the daily development process, we often need to add comments, copyrights, and other information to our class files. In the past, we copied and pasted the information text. If we added one or two pieces of information, it is very troublesome to add a lot. Is there a good solution to reduce this repetitive work? The answer is yes. In fact, each file we add is automatically generated according to the class library template, so you only need to modify the class library template of Visual Studio.

First, find the \ common7 \ ide \ itemtemplatescache \ CSHARP \ directory under the installation path of Visual Studio (2005, 2008, 2010). There are many directories on it, windows forms is the template directory for developing Windows Forms programs, and Web is the template directory for web project files. Go to the web directory and select "2052" ("2052" is the Chinese directory. Many directories with .zip are displayed. For example, to modify the template on the web page, modify "\ webform.zip \ default. aspx. cs" and open "default. aspx. cs.

1. Using system;
2. Using system. Collections. Generic;
3. $ If $ ($ targetframeworkversion $ == 3.5) using system. LINQ;
4. $ Endif $ using system. Web;
5. Using system. Web. UI;
6. Using system. Web. UI. webcontrols;
8. Namespace $ rootnamespace $
9. {
10. Public partial class $ classname $: system. Web. UI. Page
11. {
12. Protected void page_load (Object sender, eventargs E)
13. {
15. }
16. }
17. }

The characters between the "$" symbols in the Code are template variables. For more information about the variables, see:

1. <Strong> time $ date
3. $ Year
5. $ Clrversion $ CLR version
7. $ Guid $ The GUID used to replace the project guid in the project file. You can specify up to 10 unique guid1 guids )).
9. $ Itemname $ name provided by the user in the dialog box.
11. $ Machinename $ name of the current computer (for example, computer01 ).
13. $ Projectname $ name provided by the user in the dialog box.
15. $ Registeredorganization $ registry key value in HKLM \ Software \ Microsoft \ Windows NT \ CurrentVersion \ registeredorganization.
17. $ Rootnamespace $ root namespace of the current project. This parameter is used to replace the namespace in the items added to the forward project.
19. $ Safeitemname $ name provided by the user in the "Add new item" dialog box, excluding all unsafe characters and spaces.
21. $ Safeprojectname $ name provided by the user in the "New Project" dialog box, excluding all unsafe characters and spaces.
23. $ Time $ the current time in the format of DD/MM/YYYY 00:00:00.
25. $ Userdomain $ current user domain.
27. $ Username $ current user name.
29. </Strong>

My annotation example:

1. /*************************************** *********************************
2. * Project name: work log system
3. * Project description:
4. * Class Name: userinfo
5. * Version number: v1.0.0.0
6. * Description: User Information Management
7. * Author: lingyu drifting
8. * Creation Time: 13:19:28
9. * Updated at: 13:19:28
10. **************************************** ********************************
11. * Copyright @ Ling Yu studio 2011. All rights reserved.
12. **************************************** ********************************/

Follow the above instance design template:

1. /*************************************** *********************************
2. * Project name: $ rootnamespace $
3. * Project description:
4. * Class Name: $ safeitemrootname $
5. * Version number: v1.0.0.0
6. * Description:
7. * OPERATOR: $ username $
8. * Creation Time: $ time $
9. * Update Time: $ time $
10. **************************************** ********************************
11. * Copyright @ Ling Yu studio $ year $. All rights reserved.
12. **************************************** ********************************/

1. <PRE class = "CSHARP" name = "code"> using system;
2. Using system. Collections. Generic;
3. $ If $ ($ targetframeworkversion $ == 3.5) using system. LINQ;
4. $ Endif $ using system. Web;
5. Using system. Web. UI;
6. Using system. Web. UI. webcontrols;
8. Namespace $ rootnamespace $
9. {
10. Public partial class $ classname $: system. Web. UI. Page
11. {
12. Protected void page_load (Object sender, eventargs E)
13. {
15. }
16. }
17. }
18. </PRE>
19. <PRE> </PRE>
20. <P> <br>
21. Generated file: <br>
22. </P>
23. <PRE class = "CSHARP" name = "code"> /************************** **************************************** ******
24. * Project name: work log system
25. * Project description:
26. * Class Name: default2
27. * Version number: v1.0.0.0
28. * Description:
29. * Author: lingyu drifting
30. * Creation Time: 14:26:49
31. * Updated on: 14:26:49
32. **************************************** ********************************
33. * Copyright @ Ling Yu studio 2012. All rights reserved.
34. **************************************** ********************************/
35. Using system;
36. Using system. Collections. Generic;
37. Using system. LINQ;
38. Using system. Web;
39. Using system. Web. UI;
40. Using system. Web. UI. webcontrols;
42. Public partial class default2: system. Web. UI. Page
43. {
44. Protected void page_load (Object sender, eventargs E)
45. {
47. }
48. }
49. </PRE>
50. <P> </P>
51. <P> modify other templates as described above. </P>
52. <P> <br>
53. </P>

Enable Visual Studio to automatically add header comments