|
One extra slash is too much effort? 
regards,
Paul Watson
Bluegrass
South Africa
Miszou wrote:
I have read the entire internet. on how boring his day was.
Crikey! ain't life grand?
|
|
|
|
|
|
But VS.NET types it all in for you! 
I find it second nature being a HTML lamer.
regards,
Paul Watson
Bluegrass
South Africa
Miszou wrote:
I have read the entire internet. on how boring his day was.
Crikey! ain't life grand?
|
|
|
|
|
Yeah, but it conflicts with my typing style, and for me it reads like YUCK.
Further, I know how to get what I want with doxygen - XML comments are comparedly inflexible for me.
"Vierteile den, der sie Hure schimpft mit einem türkischen Säbel."
sighist | Agile Programming | doxygen
|
|
|
|
|
The best thing about using the /// XML style comments is the hints you get through IntelliSense afterwards. It's great when you have a method with 8 overloads and a large range of parameters for each one.
I always try to get a good /// in there for every public method, property etc. But I also use // wherever a comment is needed throughout the code.
|
|
|
|
|
And don't forget those // TODO: blah, // HACK: blah that both serve as inline documentation, and handily appear in the Task pane, too.
Doxygen was great, but we dropped it like a stone when VS.NET came along - we just have to type fewer characters, and get more flexibility in terms of formatting, inclusions etc.
I have to admit, however, that I might be tempted to use Doxygen still, if I *wasn't* using VS.NET, as it is more compact if you don't have intellisense behind you.
Matthew Adams
Development Manager
Digital Healthcare Ltd
|
|
|
|
|
At least he is commenting code!  Almost 13% is way too much for #3. 
-----BEGIN GEEK CODE BLOCK-----
Version: 3.21
GCS/G/MU d- s: a- C++++ UL@ P++(+++) L+(--) E--- W+++ N++ o+ K? w++++ O- M(+) V? PS-- PE Y++ PGP++ t++@ 5 X+++ R+@ tv+ b(-)>b++ DI++++ D+ G e++>+++ h---* r+++ y+++
-----END GEEK CODE BLOCK-----
|
|
|
|
|
XML documentation is great when using VSNET, since it adds all those tags automatically. It also comes very handy when during intellisense and quickinfo for your own classes.
But in case u r out with sdk coding...oh that would be too much typing...
Rakesh
|
|
|
|
|
Yeah I hate the new comment style... it is very un-reader-friendly when reading source... and that is what we spend most of our time doing, no?
I spent 2 years writing Java and using Javadoc format... and I thought that javadoc was uncool because it was a domain-specific format...
But now I see the irony that MS has chosen an "industry standard" format (XML) and I hate it and long for the days of javadocs or doxygen again!
|
|
|
|
|
I have mixed feelings about the /// xml style. I love how it makes documentation easy, but as many others have said, it makes reading the source code tough.
I wish VS.NET had an easy way to toggle whether the comments were visible or not. (If someone has a way or a good macro that does the trick, I'd love to hear!)
<insert incredibly="" witty="" sig="" here...="">
|
|
|
|
|
I just love the /// xml comments, since I don't have to look at the source code to find out what the functions does a couple weeks down the road.
I have really bad memory 
|
|
|
|
|
I think it is great having the /// comments. I generate good documentation, and the code and ddocumentation source comes from the same location. I use a similar method in my XSLT's, and a similar, but much cruder method in my javascripts
Being in a minority of one, doesn't make you insane
(George Orwell , I think)
|
|
|
|
|
|
My programming assignments have to be commented heavily so I usually use the old school method, although its python not C/C++ so it is more like # blah blah blah
Matt Newman
Sonork: 100:11179
"If you're Noah and you're facing the Flood, don't call a lawyer, start building an Ark." - David Cunningham
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
