Re: Commenting Code (was Re: An interview question)

Subject: Re: Commenting Code (was Re: An interview question)
From: Keith Hood <klhra -at- yahoo -dot- com>
To: phil stokes <philstokes03 -at- googlemail -dot- com>, Tony Chung <tonyc -at- tonychung -dot- ca>
Date: Sun, 31 Mar 2013 18:49:20 -0700 (PDT)

If you are creating code that
nobody else will ever have to use or modify, then you're right -
commenting that code would be a waste of your time.  But when I starting posting about code comments, I had in mind code that is a commercial or at least public item.


Comments in that kind of code are your explanations to the next guy who has to deal with that code.  Obviously if you are even halfway competent, you don't need comments to understand what you wrote last week.  But when you get run over by a bus and your job is taken by a guy with only half your experience, that guy will need help.  This is something that I find common among programmers; an inability or refusal to understand that they are not immoral and neither is their tenure in the job.  Comments in code you write are not a memory aid for you, they're supposed to be guidance for the next guy who has to maintain what you started, to minimize his ramp-up time. 



________________________________
From: phil stokes <philstokes03 -at- googlemail -dot- com>
To: Tony Chung <tonyc -at- tonychung -dot- ca>
Cc: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Sunday, March 31, 2013 10:05 AM
Subject: Re: Commenting Code (was Re: An interview question)

I don't see why professional coders (I'm not one; I'm still a hobbyist)
would or should bother with them.  I don't use them for the three or four
languages I know well. For others, I use them less in inverse proportion to
my mastery of the syntax.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help sample with DISQUS for user commenting?

Learn more: http://bit.ly/13xpg5n

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
Commenting Code (was Re: An interview question): From: phil stokes
Re: Commenting Code (was Re: An interview question): From: Tony Chung
Re: Commenting Code (was Re: An interview question): From: phil stokes

Previous by Author: Re: An interview question
Next by Author: Re: Technial documentation copyright issue
Previous by Thread: Re: Commenting Code (was Re: An interview question)
Next by Thread: Re: Commenting Code (was Re: An interview question)


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads