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-writing it so it is done properly only to realise after that a bug exists.
Do docstrings/javadocs count as comments? I agree about no 'person x made this change on y because of issue z' comments though; if your source control doesn't make that easy to determine, then get a new source control system. On 13 September 2013 17:56, Davy Jones <[email protected]> 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 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. > If you add them to Blame later, you should be doing peer reviewed checkins > to bring everyone up to the same level. > If you are commenting code because it might be useful later. Delete it! > That is what source control is for. > > There is no excuse for comments in code. > > Davy > > Sent from my starfleet datapad. > > On 13 sept. 2013, at 08:56, mike smith <[email protected]> wrote: > > 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 you might need to generate a hotfix. With all the caveats that > hotfixes imply :) If your devs are diligent linking the svn comment with a > number from your CR system, that's another link. > > But I'd hate to see it actually present in the code. > > > > > On Fri, Sep 13, 2013 at 2:50 PM, Craig van Nieuwkerk <[email protected]>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 code. >> >> >> On Fri, Sep 13, 2013 at 2:45 PM, <[email protected]> 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 XX=PROGRAMMER >>> INITIALS**** >>> >>> ** ** >>> >>> WE use TFS but we like to write comments in code sometimes. Any >>> extensions able to do this?**** >>> >>> ** ** >>> >>> Anthony**** >>> >>> Melbourne StuffUps…learn from others, share with others!**** >>> >>> http://www.meetup.com/Melbourne-Ideas-Incubator-Stuffups-Failed-Startups/ >>> **** >>> >>> >>> >>> ---------------------------------------------------------------------------------- >>> NOTICE : The information contained in this electronic mail message is >>> privileged and confidential, and is intended only for use of the addressee. >>> If you are not the intended recipient, you are hereby notified that any >>> disclosure, reproduction, distribution or other use of this communication >>> is strictly prohibited. >>> If you have received this communication in error, please notify the >>> sender by reply transmission and delete the message without copying or >>> disclosing it. (*13POrtC*) >>> >>> ----------------------------------------------------------------------------------- >>> **** >>> >>> ** ** >>> >> >> > > > -- > Meski > > http://courteous.ly/aAOZcv > > "Going to Starbucks for coffee is like going to prison for sex. Sure, > you'll get it, but it's going to be rough" - Adam Hills > >
