How to Comment Code Better
Ryan Campbell has posted some good tips on practical approaches to writing better comments.
His article should help you find the median between over commenting, and not commenting enough.
Commenting your code is like cleaning your bathroomyou never want to do it, but it really does create a more pleasant experience for you and your guests...
there are a lot of tough, but fundamental questions out there like what does "frequently and appropriately" mean? Because there are a million different beliefs and contradictions on the subject, I created this brief overview to present my findings
Tweet
add to del.icio.usRelated Entries
- Fonts for Programmers - May 12, 2005
Trackbacks
Comments
I'd just like to see a hint attribute on cfparam (any chance, do ya reckon?)
my 2c barry.b
http://particletree.com/features/successful-strategies-for-commenting-code/
<quote> Commenting while you code forces you to make sure your logic ?sounds right.? Plus, your comments are going to be more accurate when the understanding of what?s going on behind-the-scenes is fresh in your mind. </quote>
has writing pseudocode beforehand fallen out of favour? do ppl no longer map out what they want to do (in pseudocode), use that as comments in the source and then add real code around it?
are all my habits (that have served me well) now "old hat"?
has writing pseudocode beforehand fallen out of favour? do ppl no longer map out what they want to do (in pseudocode), use that as comments in the source and then add real code around it?
Post a Comment
Recent Entries
- Nginx redirect www to non www domain
- HashDOS and ColdFusion
- HackMyCF Updated for APSB11-29 Security Hotfix
- Adobe eSeminar on FuseGuard
- Determining Which Cumulative Hotfixes are Installed on ColdFusion
- Adding Two Factor Authentication to ColdFusion Administrator
- ColdFusion Developer Week at Adobe.com
- Bug Loading Scripts for CFFileUpload and CFMediaPlayer
