tag:blogger.com,1999:blog-1697388841986104302.post4187236662763349497..comments2023-07-02T10:36:44.294-05:00Comments on Agile in a Flash: Rules for CommentingAgileotterhttp://www.blogger.com/profile/10773578598860454277noreply@blogger.comBlogger4125tag:blogger.com,1999:blog-1697388841986104302.post-27525643213744697142009-04-10T13:56:00.000-05:002009-04-10T13:56:00.000-05:00Yes you're right. I had to give "provide informati...Yes you're right. I had to give "provide information that is not expressible in code" some time to sink in.<BR/><BR/>That's actually exactly my point.<BR/><BR/>Thanks for clearing things up.Urs Enzlerhttps://www.blogger.com/profile/10173393221263632511noreply@blogger.comtag:blogger.com,1999:blog-1697388841986104302.post-11649135083659899772009-04-10T10:51:00.000-05:002009-04-10T10:51:00.000-05:00That's no disagreement at all, Urs Enzler. If the...That's no disagreement at all, Urs Enzler. If the .NET code could express whether null was acceptable or not, you wouldn't need that comment. Likewise if there were clear indications in code that null would NOT be returned. Of course, tests are specification, and specification is documentation, so you might have an out if you can find the tests.Agileotterhttps://www.blogger.com/profile/10773578598860454277noreply@blogger.comtag:blogger.com,1999:blog-1697388841986104302.post-11425595328947365142009-04-10T09:23:00.000-05:002009-04-10T09:23:00.000-05:00I'd put this a bit different:If you are reading th...I'd put this a bit different:<BR/><BR/>If you are reading the code of someone else then the code should be as clean und understandable that there is no need of comments despite the things you state under "Comments provide information that is not expressible in code"<BR/><BR/>However, if you are using someone elses code and seeing therefore only the interfaces then it is very important to have comments that explain how the code will react to calls. I'm a .net guy and it is very helpful to have comments on the methods that state whether 'null' is a value that will be accepted in IntelliSense.<BR/><BR/>For short: don't comment to explain the code, comment to make it easier usable.Urs Enzlerhttp://www.planetgeek.chnoreply@blogger.comtag:blogger.com,1999:blog-1697388841986104302.post-47519357397839456282009-04-02T14:59:00.000-05:002009-04-02T14:59:00.000-05:00In a couple cases I was faced with code that had a...In a couple cases I was faced with code that had a massive excess of horrid, stupid comments. In Eclipsed, I changed the syntax coloring so that comments were not grey but instead that they were white. Very effective! :-)Jeff Langrhttps://www.blogger.com/profile/10499693020049210645noreply@blogger.com