[MonoDevelop] Should templates contain xml documentation ?

[Peter Hultqvist]

2010-11-11 13:05, Mike Krüger skrev:
> 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:
> ----------------
> ...
> 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 ()
>          {
>          }
>      }
> }
>
>
I think it could be a good thing, it would be a good reminder. Usually
people go by the default, and if there are documentation tags by default
it will encourage people to think about what to write more.

I do see problems with the example though.
First, it would be annoying having to remove text before writing your
own. Second, the comment for the constructor is totally useless since
the documentation should be for the developer to document their
contribution, not the basics of the language.

So I would suggest:

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

namespace Application
{
     /// <summary>
     /// 
     /// </summary>
     public class NewClass
     {
         /// <summary>
         /// 
         /// </summary>
         public NewClass ()
         {
         }
     }
}