What are the virtues of using XML comments in .NET?

Posted by Michal Czardybon on Stack Overflow See other posts from Stack Overflow or by Michal Czardybon
Published on 2010-04-06T12:55:36Z Indexed on 2010/04/06 13:03 UTC
Read the original article Hit count: 292

Filed under:

xml-comments

|

best-practices

|

c#

I can't understand the virtues of using XML comments. I know they can be converted into nice documentation external to the code, but the same can be achieved with the much more concise DOxygen syntax. In my opinion the XML comments are wrong, because:

They obfuscate the comments and the code in general. (They are more difficult to read by humans).
Less code can be viewed on a single screen, because "summary" and "/summary" take additional lines.
They suggest that all method parameters have to be commented, whereas 90% of them are obvious and SHOULD be left not commented.

The only problem I have with this is that my point of view seems to be in minority. Why?

© Stack Overflow or respective owner

Related posts about xml-comments

C# XML comments - build a list

as seen on Stack Overflow - Search for 'Stack Overflow'
I am trying to build a list for my XML comments on my C# method. I am using the following document, however the list implementation in this does not work for me. I am using visual studio 2008 and .net 3.5. http://msdn.microsoft.com/en-us/magazine/cc302121.aspx How do I build a list using XML comments… >>> More
Convert Doxygen to XML comments

as seen on Stack Overflow - Search for 'Stack Overflow'
We have a C# project which for historical reasons uses both Doxygen and Visual Studio style comments in the same code. Has anyone tried to systematically translate one standard to another, preferably to the common XML subset? I guess it would not be too difficult to write a script to cover the most… >>> More
XML comments on delegate declared events

as seen on Stack Overflow - Search for 'Stack Overflow'
I am visiting some old code, and there are quite a few events declared with delegates manually rather than using EventHandler<T>, like this: /// <summary> /// Delegate for event Added /// </summary> /// <param name="index">Index of the item</param> /// <param name="item">The… >>> More
C# Style XML Comments in Delphi 2010

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, does Delphi 2010 have C# Style XML comments that show up when hovering over the method call? /// <summary> /// My comment here /// </summary> >>> More
Selectively suppress XML comments?

as seen on Stack Overflow - Search for 'Stack Overflow'
We deliver a number of assemblies to external customers, but not all of the public APIs are officially supported. For example, due to less than optimal design choices sometimes a type must be publicly exposed from an assembly for the rest of our code to work, but we don't want customers to use that… >>> More

Related posts about best-practices

Batch Best Practices and Technical Best Practices Updated

as seen on Oracle Blogs - Search for 'Oracle Blogs'
The Batch Best Practices for Oracle Utilities Application Framework based products (Doc Id: 836362.1) and Technical Best Practices for Oracle Utilities Application Framework Based Products (Doc Id: 560367.1) have been updated with updated and new advice for the various versions of the Oracle… >>> More
Partial template specialization of free functions - best practices

as seen on Stack Overflow - Search for 'Stack Overflow'
As most C++ programmers should know, partial template specialization of free functions is disallowed. For example, the following is illegal C++: template <class T, int N> T mul(const T& x) { return x * N; } template <class T> T mul<T, 0>(const T& x) { return T(0); } //… >>> More
Object Oriented PHP Best Practices

as seen on Stack Overflow - Search for 'Stack Overflow'
Say I have a class which represents a person, a variable within that class would be $name. Previously, In my scripts I would create an instance of the object then set the name by just using: $object->name = "x"; However, I was told this was not best practice? That I should have a function set_name()… >>> More
Good place to look for example Database Designs - Best practices

as seen on Stack Overflow - Search for 'Stack Overflow'
I have been given the task to design a database to store a lot of information for our company. Because the task is rather big and contains multiple modules where users should be able to do stuff, I'm worried about designing a good data model for this. I just don't want to end up with a badly designed… >>> More
Notification Email Best Practices--From Server Setup to Programming

as seen on Stack Overflow - Search for 'Stack Overflow'
All, I'm in the process now of building a SaaS tool that allows network admins to generate notification emails to the members of the end-users of our platform (among many many other things). I'm running into a bit of an "out of my expertise" wall, as I know there are a lot of variables involved… >>> More