RE: code examples

["walden miller" <wmiller -at- vidiom -dot- com>]

> when citing code examples within a document, even if they are
> there only for example, not instruction, should they be described
> and labeled every time???

while your question is highly contextual, a quick answer is label the code
as appropriate.

If you are showing a code fragment to exemplify some function use or
construct, then you probably don't need to label it as coming from a larger
function, etc.  However, if you need to provide some context for the example
code to make sense, then you should label it.  Labels make sense when they
add something (which may include the ability to search for the code example
by label).  Otherwise, they are only there to satisfy our anal desires to
categorize.

walden


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Take XML and Tech Writing courses online!  Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off!  http://www.online-learning.com/index.html.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit 
http://www.raycomm.com/techwhirl/ for more resources and info.