[MonoDevelop] Should templates contain xml documentation ?

Mike Krüger mkrueger at novell.com
Fri Nov 12 05:14:53 EST 2010


Thanks for all these reponses - my first intention was just closing the 
request with 'wontfix'. Most people seem to share the opinion that xml 
documentation as default is more harm than good.

The post from Bob Lang brings that to the point - we have the best of 
two worlds with the 'document buffer' command it's really easy to add 
documentation templates - if anyone really wants them but for the 
majority of us it's not useful.

Another point is that xml documentation for internal types isn't needed 
- only for public members - and many new classes are internal.


> Hi all
> As a programming teacher, I find I'm in conflict! With newby programmers, I find it's best not to put in stuff which will confuse them, but later on the same students would appreciate a documentation skeleton to prompt them with their comments.
> What I think would be useful would be for the template *not* to have the documentation template by default, but for the editor to have an extra command which will decorate the current method/class/whatever on demand with an appropriate comment skeleton.
> I think this would be the best of both worlds.
> Bob
> _______________________________________________
> Monodevelop-list mailing list
> Monodevelop-list at lists.ximian.com
> http://lists.ximian.com/mailman/listinfo/monodevelop-list

More information about the Monodevelop-list mailing list