Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Customize C# Standard Document Generators (XML Comments) in Visual Studio

  • Is there any other kind of documentation generator shortcuts for C# (like /// Generates function() Code) or any tool item (like signature in email @ outlook) in VS IDE, For following MS Standard Coding & Documentation & making understand to other co-developer working on same project.
  • How to change the Format of the Generated document in visual stdio IDE by default comment format to custom comment format shown below.

Ex:

 1. **Default Format**

     // Name:      
     // Author:     
     // Description: <summary></summary>    
     // Parameters: <param name="abc"></praram>  
     // Returned Value: <returns></returns>

 2. **New Custom Format**

     // Application:  <project></project>  <version></version> 
     // Created Developer: <developer></developer>
     // Created Date: <date></date>  
     // Last Modified:     
     // Last Modified Developer:     
     // Parameters: <param name="abc"></praram>      
     // Return Type: <returns></returns>    
     // Description: <summary></summary>
like image 760
Mark Macneil Bikeio Avatar asked Nov 01 '22 14:11

Mark Macneil Bikeio


1 Answers

Not sure if you mean instead of the /// comments but there are lots of options from this question here:

https://stackoverflow.com/questions/641364/c-sharp-documentation-generator

There is also these articles here:

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx#id0400027

http://blogs.msdn.com/b/lisa/archive/2010/05/25/how-to-customize-the-xml-comments-that-are-inserted-by-the-visual-basic-code-editor.aspx

like image 83
John Avatar answered Nov 13 '22 15:11

John