Click here to Skip to main content

The Weird and The Wonderful

   

The Weird and The Wonderful forum is a place to post Coding Horrors, Worst Practices, and the occasional flash of brilliance.

We all come across code that simply boggles the mind. Lazy kludges, embarrasing mistakes, horrid workarounds and developers just not quite getting it. And then somedays we come across - or write - the truly sublime.

Post your Best, your worst, and your most interesting. But please - no programming questions . This forum is purely for amusement and discussions on code snippets. All actual programming questions will be removed.

 
GeneralRe: ... WHY?! PinprofessionalBernhard Hiller21-Nov-13 22:56 
GeneralRe: ... WHY?! PinmemberMatt U.22-Nov-13 4:38 
JokeRe: ... WHY?! Pinmemberwalterhevedeich25-Nov-13 23:54 
GeneralRe: ... WHY?! PinprofessionalBernhard Hiller26-Nov-13 0:35 
GeneralRe: ... WHY?! PinmemberGiuseppe Tollini21-Nov-13 10:33 
GeneralRe: ... WHY?! PinmemberMatt U.21-Nov-13 11:03 
GeneralOver-documentation PinprofessionalRon Beyer16-Nov-13 15:46 
GeneralRe: Over-documentation PinprofessionalPIEBALDconsult16-Nov-13 16:15 
GeneralRe: Over-documentation PinprotectorOriginalGriff16-Nov-13 23:20 
GeneralRe: Over-documentation PinprofessionalPIEBALDconsult17-Nov-13 6:26 
GeneralRe: Over-documentation PinprotectorOriginalGriff17-Nov-13 6:42 
GeneralRe: Over-documentation PinmemberMax Methot28-Nov-13 6:01 
GeneralRe: Over-documentation PinprofessionalPIEBALDconsult28-Nov-13 6:45 
GeneralRe: Over-documentation PinmemberSander Rossel17-Nov-13 1:09 
The real question is where should commenting stop?
I have some coworkers who comment .NET functions and classes that we don't use a lot. Especially when it's more complex and intellisense alone won't help you a lot.
Just assume we don't use strings a lot. It would be something like:
// A string is used to store some text.
string s = "Hello!";
Someone at our company might not know what a string is (after all, we rarely use it (in this example)), so this will save them a quick Google lookup.
At the other hand, is it really our job to document .NET classes?
 
Your example is clearly a little too much though! Laugh | :laugh: Thumbs Up | :thumbsup:
It's an OO world.
public class Sander : Lazy<Person>{
    public void DoWork(){ throw new NotImplementedException(); }
}

GeneralRe: Over-documentation PinprofessionalRon Beyer17-Nov-13 6:21 
GeneralRe: Over-documentation PinmemberSander Rossel17-Nov-13 7:54 
GeneralRe: Over-documentation [modified] PinmemberENOTTY18-Nov-13 6:24 
GeneralRe: Over-documentation PinprofessionalRon Beyer18-Nov-13 6:41 
GeneralRe: Over-documentation Pinmember d@nish 17-Nov-13 7:20 
GeneralRe: Over-documentation PinprofessionalRon Beyer17-Nov-13 7:55 
GeneralRe: Over-documentation PinprofessionalBernhard Hiller18-Nov-13 0:01 
GeneralRe: Over-documentation PinmemberENOTTY18-Nov-13 6:05 
GeneralRe: Over-documentation PinmvpCPallini18-Nov-13 8:39 
GeneralRe: Over-documentation PinprotectorMarc Clifton19-Nov-13 9:24 
GeneralRe: Over-documentation PinmemberStewart Judson20-Nov-13 1:49 
GeneralRe: Over-documentation PinprofessionalRon Beyer20-Nov-13 4:08 
GeneralRe: Over-documentation Pinmembers_mon25-Nov-13 10:56 
GeneralRe: Over-documentation PinmemberRob Grainger28-Nov-13 23:26 
GeneralRe: Over-documentation PinmemberVasudevan Deepak Kumar29-Nov-13 2:54 
GeneralAbsolutely necessary Pinmemberimagiro16-Dec-13 0:00 
GeneralRe: Over-documentation PinmemberJacek Gajek27-Dec-13 2:05 
GeneralVS Go BOOM! PinprofessionalBrisingr Aerowing15-Nov-13 13:54 
GeneralRe: VS Go BOOM! PinprotectorDaveAuld15-Nov-13 21:38 
GeneralRe: VS Go BOOM! Pinmemberdevvvy16-Nov-13 23:51 
GeneralRe: VS Go BOOM! PinmemberIm_no_troll18-Dec-13 11:19 
GeneralRe: VS Go BOOM! PinmemberJacek Gajek27-Dec-13 2:13 
GeneralRe: VS Go BOOM! PinmemberSander Rossel17-Nov-13 1:10 
GeneralRe: VS Go BOOM! PinmemberJacek Gajek27-Dec-13 2:16 
GeneralDetect user in group only once PinmemberSortaCore15-Nov-13 1:15 
GeneralRe: Detect user in group only once PinmemberJacek Gajek15-Nov-13 1:31 
GeneralRe: Detect user in group only once PinmemberSortaCore15-Nov-13 1:32 
GeneralRe: Detect user in group only once PinmemberJacek Gajek15-Nov-13 1:43 
GeneralRe: Detect user in group only once PinmemberSortaCore15-Nov-13 1:53 
GeneralRe: Detect user in group only once PinprofessionalPIEBALDconsult15-Nov-13 3:57 
GeneralRe: Detect user in group only once PinprotectorMarc Clifton17-Nov-13 5:38 
GeneralWhat is an Object [modified] Pinprofessionalmichaelbarb14-Nov-13 9:44 
GeneralRe: What is an Object PinprotectorDaveAuld14-Nov-13 10:00 
GeneralRe: What is an Object Pinprofessionalmichaelbarb14-Nov-13 10:16 
GeneralRe: What is an Object PinprofessionalJoan Murt14-Nov-13 10:10 
GeneralRe: What is an Object PinprofessionalRichard Deeming14-Nov-13 10:17 

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

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


Advertise | Privacy | Mobile
Web03 | 2.8.150302.1 | Last Updated 6 Mar 2015
Copyright © CodeProject, 1999-2015
All Rights Reserved. Terms of Service
Layout: fixed | fluid