Re: code examples in a document

[dmbrown -at- brown-inc -dot- com]

"Mike O." wrote:
> 
> Find out what [the] language uses for a
> line continuation marker...

Absolutely.  Wherever possible, make sure your code examples can be cut from the doc, pasted directly into a source file, and successfully compiled (or interpreted or whatever).

Sometimes, though, there simply *aren't* any syntactically acceptable line break locations.

In those cases, pick a continuation character that couldn't occur in the code itself.  (I like the dingbat that looks like a folded-over arrow.)  Flag it with a distinctive color, and include a note that explains clearly what's going on.

--David 
 
========================================================================

N O W   A V A I L A B L E !                http://www.html-indexer.com/

HTML Indexer 4 is still the easiest way to create and maintain indexes 
for web sites, intranets, HTML Help, JavaHelp, and other HTML documents.

Now with fully integrated cross-references, target frames and windows, 
multiple-file output, "one-step accept" of default entries, and more!

 


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l

Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!

---
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.