Survey Results

FirstPrev Next

/// - doxygen style peterchen12-Oct-03 23:39 peterchen 12-Oct-03 23:39  I tried the XML - Style first, but that's to much of a pain to type. "Vierteile den, der sie Hure schimpft mit einem türkischen Säbel." sighist | Agile Programming | doxygen Re: /// - doxygen style Paul Watson13-Oct-03 0:48 Paul Watson 13-Oct-03 0:48  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? Re: /// - doxygen style peterchen13-Oct-03 1:38 peterchen 13-Oct-03 1:38  No, but \param x is better than <param>x</param> "Vierteile den, der sie Hure schimpft mit einem türkischen Säbel." sighist | Agile Programming | doxygen Re: /// - doxygen style Paul Watson13-Oct-03 1:42 Paul Watson 13-Oct-03 1:42  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? Re: /// - doxygen style peterchen13-Oct-03 1:46 peterchen 13-Oct-03 1:46  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 Re: /// - doxygen style Frode N. Rosand14-Oct-03 21:13 Frode N. Rosand 14-Oct-03 21:13  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. Re: /// - doxygen style Matthew Adams14-Oct-03 21:36 Matthew Adams 14-Oct-03 21:36  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 Re: /// - doxygen style Heath Stewart13-Oct-03 3:50 Heath Stewart 13-Oct-03 3:50  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----- Re: /// - doxygen style Rakesh Rajan13-Oct-03 6:52 Rakesh Rajan 13-Oct-03 6:52  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 Re: /// - doxygen style Anonymous13-Oct-03 9:34 Anonymous 13-Oct-03 9:34  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! Re: /// - doxygen style Noah Duke14-Oct-03 7:41 Noah Duke 14-Oct-03 7:41  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...=""> /// Nick Seng12-Oct-03 22:48 Nick Seng 12-Oct-03 22:48  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 Support Bone comments Mark Focas12-Oct-03 18:59 Mark Focas 12-Oct-03 18:59  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) 1, but pseudonym6712-Oct-03 18:48 pseudonym67 12-Oct-03 18:48  Seeing as I've always seemed to be fixing other peoples code when at work I've always used the /// for comments instead of // I've been using it since the early 90's as a way of identifying my comments when maintaining code so as to distinguish them from the original writers comments, where there were any. B*&(((&ds stole my idea. Should I sue? pseudonym67 Neural Dot Net Articles 1-11 Start Here Fuzzy Dot Net Articles 1-4 Start Here PathFinder Game Of Life 2 Life Wars #3 but.. Matt Newman12-Oct-03 18:15 Matt Newman 12-Oct-03 18:15  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

Last Visit: 31-Dec-99 18:00     Last Update: 15-Jun-24 5:51 Refresh ᐊ Prev123

General    News    Suggestion    Question    Bug    Answer    Joke    Praise    Rant    Admin   

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