Click here to Skip to main content
15,914,013 members

Survey Results

Do you use C# style XML comments when programming?   [Edit]

Survey period: 9 May 2005 to 15 May 2005

XML comments make documentation easy and they don't have to be reserved for C# only. Regardless of your programming language, do you use XML comments? (suggested by Matthias Steinbart)

OptionVotes% 
I don't use C# and don't use XML comments at all41032.83
I use C# and don't use them at all20916.73
I only provide summaries15512.41
I provide summaries, return values and parameters37029.62
I provide everything including fully formatted remarks, examples and exception tags.1058.41



 
GeneralRe: Double-edged sword Pin
Bob Stanneveld12-May-05 22:13
Bob Stanneveld12-May-05 22:13 
GeneralRe: Double-edged sword Pin
Kevin McFarlane11-May-05 9:31
Kevin McFarlane11-May-05 9:31 
GeneralRe: Double-edged sword Pin
SHaroz11-May-05 18:21
SHaroz11-May-05 18:21 
GeneralNo Pin
PJ Arends8-May-05 21:59
professionalPJ Arends8-May-05 21:59 
GeneralRe: No Pin
David Wulff9-May-05 3:23
David Wulff9-May-05 3:23 
GeneralRe: No Pin
Anna-Jayne Metcalfe9-May-05 5:49
Anna-Jayne Metcalfe9-May-05 5:49 
GeneralRe: No Pin
Jim A. Johnson9-May-05 7:04
Jim A. Johnson9-May-05 7:04 
GeneralRe: No Pin
Shog99-May-05 10:43
sitebuilderShog99-May-05 10:43 
I agree.

As code goes, XML is pretty easy to read. But if i wanted to read code, i wouldn't be wasting time on the comment block at all!

So here's the deal: i'll write XML comments when a version of VS defaults to displaying them with the tags stripped out (or rendered in a visually-pleasing manner). After all, if i wanted to start a browser to read the docs for my own code, i'd write them in a Wiki and skip the XML stuff completely.

You must be careful in the forest
Broken glass and rusty nails
If you're to bring back something for us
I have bullets for sale...

GeneralI provide summaries, return values and parameters ... Pin
Roland Bär8-May-05 21:49
Roland Bär8-May-05 21:49 
GeneralRe: I provide summaries, return values and parameters ... Pin
David Wulff9-May-05 3:16
David Wulff9-May-05 3:16 
GeneralRe: I provide summaries, return values and parameters ... Pin
Ray Cassick9-May-05 7:23
Ray Cassick9-May-05 7:23 
GeneralRe: I provide summaries, return values and parameters ... Pin
David Wulff9-May-05 7:29
David Wulff9-May-05 7:29 
GeneralRe: I provide summaries, return values and parameters ... Pin
Blake Miller10-May-05 4:16
Blake Miller10-May-05 4:16 
GeneralRe: I provide summaries, return values and parameters ... Pin
David Wulff10-May-05 5:26
David Wulff10-May-05 5:26 
GeneralRe: I provide summaries, return values and parameters ... Pin
Shog910-May-05 17:38
sitebuilderShog910-May-05 17:38 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.