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
add to del.icio.usRelated Entries
- Fonts for Programmers - May 12, 2005
Trackbacks
Trackback Address: 428/00F4868B1811849403191D58EE7A9420
Comments
On 08/02/2005 at 2:09:31 AM EDT barry.b wrote:
1
"placeholders" like hint and displayName are (IMHO) a great backhand way of commenting code.
I'd just like to see a hint attribute on cfparam (any chance, do ya reckon?)
my 2c barry.b
On 11/24/2005 at 7:51:09 AM EST manoj wrote:
2
Hi, I ws searching everywhere for this particletree article, but they all are just links to the same one, which is missing now. Do you have the article in complete? or atleast where can I find it?
On 04/12/2006 at 5:57:08 PM EDT Cadoc wrote:
3
A search on Particle Tree yielded the following:
http://particletree.com/features/successful-strategies-for-commenting-code/
On 04/12/2006 at 7:53:14 PM EDT barry.b wrote:
4
Pete:
<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"?
On 05/11/2009 at 11:39:09 AM EDT aaaaaaaa wrote:
5
?fgdgdg s?erdercenes 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?
Post a Comment
Recent Entries
- Cache Template in Request Setting Explained
- What Version of Java is ColdFusion Using?
- ColdFusion 9 Performance Brief from Adobe
- Request Filtering in IIS 7 Howto
- J2EE Session Cookies on ColdFusion / JRun
- Hands on ColdFusion Security Training
- ColdFusion 9 Solr Vulnerability - Are you at Risk?
- FCKEditor Year 2010 Bug for Firefox 3.6 with ColdFusion
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?
