Comments on: Overcommented code http://www.stevensmedia.com/blog/php/overcommented-code/ Sam Stevens' Web Development Blog Tue, 6 Jan 2009 18:32:06 +0000 http://wordpress.org/?v=2.0.11 by: Sam Stevens http://www.stevensmedia.com/blog/php/overcommented-code/#comment-667 Sun, 30 Apr 2006 19:54:32 +0000 http://www.stevensmedia.com/blog/php/overcommented-code/#comment-667 Thank you for taking the time to post a comment, Joe! Your reasoning makes perfect sense, and I too believe in good inline documentation/attribution. It seemed a little out of place to me in a public article series, but I certainly see the usefulness in a workplace setting. Thanks again for stopping by, and for the informative articles! Thank you for taking the time to post a comment, Joe! Your reasoning makes perfect sense, and I too believe in good inline documentation/attribution. It seemed a little out of place to me in a public article series, but I certainly see the usefulness in a workplace setting. Thanks again for stopping by, and for the informative articles!

]]> by: Joe Stump http://www.stevensmedia.com/blog/php/overcommented-code/#comment-646 Sun, 23 Apr 2006 01:55:21 +0000 http://www.stevensmedia.com/blog/php/overcommented-code/#comment-646 I've since switched to dropping my name into the file docblock and the class dockblock, but there *is* a reason for tagging each function with an @author tag. The company I work for has 3 full time programmers and, at various times, contractors working on the code. A single class might have 10 functions with each one programmed by someone else, hence the @author tag on each function. Also the extreme amount of documentation was meant to be a part of the article and not necessarily my recommendations for commenting, though I'm a firm believer in phpDocumentor and documentation as a whole. I've since switched to dropping my name into the file docblock and the class dockblock, but there *is* a reason for tagging each function with an @author tag. The company I work for has 3 full time programmers and, at various times, contractors working on the code. A single class might have 10 functions with each one programmed by someone else, hence the @author tag on each function.

Also the extreme amount of documentation was meant to be a part of the article and not necessarily my recommendations for commenting, though I'm a firm believer in phpDocumentor and documentation as a whole.

]]>