Re: Code commenting

2013-09-15 Thread Corneliu I. Tusnea
If it was hard to write it should be hard to read :) Why comment? On Fri, Sep 13, 2013 at 5:56 PM, Davy Jones djones...@gmail.com wrote: Hello If you are doing this in code. It points to the fact that someone is not pulling their weight. Code should not have comments. If you need them to

Re: Code commenting

2013-09-15 Thread mike smith
Just run it thru an obfuscator before committing it On Mon, Sep 16, 2013 at 9:46 AM, Corneliu I. Tusnea corne...@acorns.com.auwrote: If it was hard to write it should be hard to read :) Why comment? On Fri, Sep 13, 2013 at 5:56 PM, Davy Jones djones...@gmail.com wrote: Hello If you are

Re: Code commenting

2013-09-13 Thread William Luu
*To:* ozDotNet *Subject:* Re: Code commenting ** ** A lot of source control systems give you that out of the box. I know Git and SVN both do with the BLAME command. I wouldn't want the comments scattered throughout the code. ** ** On Fri, Sep 13, 2013 at 2:45 PM, anthonyatsmall

Re: Code commenting

2013-09-13 Thread mike smith
Blame is a useful tool, ofttimes though, I'd call it credit. For instance, you receive a crashdump from an old version, it shows you where the app crashed, and maybe you have a slight idea why. Use blame on a current version, look at changes around the crash line and you've got a lot of the info

Re: Code commenting

2013-09-13 Thread Davy Jones
Hello If you are doing this in code. It points to the fact that someone is not pulling their weight. Code should not have comments. If you need them to explain something, the code is too complex. If you add them so modifications on one bit of code come back to you so you can fix. Make it simpler.

Re: Code commenting

2013-09-13 Thread Sam Lai
No comments at all is a bit extreme. I get what you're saying, but there are still valid reasons for comments. For example, if you had to do an unusual hack because of a bug in the framework, you'd want to leave a comment in the code so the next person who comes along doesn't spend hours

Re: Code commenting

2013-09-13 Thread David Rhys Jones
For the last 5 years or so the only comments that I have left in code. are the public interface XML comments that are well written with examples. not the usual you find. /// summary /// Gets the User by Id /// /summary public void GetUserById(long id){} I have left comments that point out that a

Code commenting

2013-09-12 Thread anthonyatsmallbiz
Anyone suggest a method to autmaticlly comment code when lines have changed? Would be great to be able to see who changed what when viewing the code. At the moment,, we write comments like //xxMOD 12AUG13 XX=PROGRAMMER INITIALS WE use TFS but we like to write comments in code sometimes.

Re: Code commenting

2013-09-12 Thread Joseph Cooney
TFS annotate? On 13 Sep 2013 14:47, anthonyatsmall...@mail.com wrote: Anyone suggest a method to autmaticlly comment code when lines have changed? Would be great to be able to see who changed what when viewing the code. ** ** At the moment,, we write comments like //xxMOD 12AUG13

Re: Code commenting

2013-09-12 Thread Craig van Nieuwkerk
A lot of source control systems give you that out of the box. I know Git and SVN both do with the BLAME command. I wouldn't want the comments scattered throughout the code. On Fri, Sep 13, 2013 at 2:45 PM, anthonyatsmall...@mail.com wrote: Anyone suggest a method to autmaticlly comment code

RE: Code commenting

2013-09-12 Thread anthonyatsmallbiz
...@ozdotnet.com [mailto:ozdotnet-boun...@ozdotnet.com] On Behalf Of Craig van Nieuwkerk Sent: Friday, 13 September 2013 2:50 PM To: ozDotNet Subject: Re: Code commenting A lot of source control systems give you that out of the box. I know Git and SVN both do with the BLAME command. I wouldn't want

Re: Code commenting

2013-09-12 Thread Preet Sangha
Of *Craig van Nieuwkerk *Sent:* Friday, 13 September 2013 2:50 PM *To:* ozDotNet *Subject:* Re: Code commenting ** ** A lot of source control systems give you that out of the box. I know Git and SVN both do with the BLAME command. I wouldn't want the comments scattered throughout the code

Re: Code commenting

2013-09-12 Thread Joseph Cooney
Annotate is the 'glass is half full' name for blame in TFS. On 13 Sep 2013 14:50, Craig van Nieuwkerk crai...@gmail.com wrote: A lot of source control systems give you that out of the box. I know Git and SVN both do with the BLAME command. I wouldn't want the comments scattered throughout the