[MonoDevelop] Should templates contain xml documentation ?

Mike Krüger mkrueger at novell.com
Thu Nov 11 07:05:35 EST 2010


Hi

We've templates for new files - the question is if we should put xml 
comments per default in the new templates.
For example - now we have:
----------------
using System;

namespace Application
{
     public class NewClass
     {
         public NewClass ()
         {
         }
     }
}

With xml documentation:
----------------
using System;

namespace Application
{
     /// <summary>
     /// Description of NewClass.
     /// </summary>
     public class NewClass
     {
         /// <summary>
         /// Initializes a new instance of the <see 
cref="Application.NewClass"/> class.
         /// </summary>
         public NewClass ()
         {
         }
     }
}

Visual studio generates it without templates. But I've a bug open about 
one who likes the xml documentation. My preference (now) is that we 
don't generate xml comments - because it's easy to add them in monodevelop.

Any thoughts ?

Regards
Mike




More information about the Monodevelop-list mailing list