RE: [External] Commenting Code (was Re: An interview question)

Subject: RE: [External] Commenting Code (was Re: An interview question)
From: "Chinell, Bear CCS" <David -dot- Chinell -at- fs -dot- utc -dot- com>
To: phil stokes <philstokes03 -at- googlemail -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- techwr-l -dot- com>
Date: Mon, 1 Apr 2013 17:51:07 +0000

I'm the sole author in this shop, so I use comments in my VBA code as notes to myself.

I don't use comments to remind me what's going on, but to record what my strategy was for doing it in the first place. It sort of links the code back to the business case.

I also use comments to prevent me from reworking stuff using a "better" approach that ends up not working. Sometimes I'd already tried the "better" approach in the first place and had to use a less elegant approach to compensate for bugs in VBA.

Bear
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>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


Previous by Author: RE: Advice needed for an upcoming interview
Next by Author: Re: thick client vs web access
Previous by Thread: TECHWR-L Premium Jobs, Events, and Announcements
Next by Thread: Wikipedia question


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

Sponsored Ads


Sponsored Ads