[MonoDevelop] Should templates contain xml documentation ?

Lluis Sanchez Gual slluis.devel at gmail.com
Thu Nov 11 09:41:54 EST 2010


El dj 11 de 11 de 2010 a les 13:05 +0100, en/na Mike Krüger va escriure:
> 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.

I agree. Adding comments in the templates will not be a big usability
improvement for people using this kind of comments, and really annoying
to those who don't.

Lluis.




More information about the Monodevelop-list mailing list