Re: Representing variables

[Joe Malin <jmalin -at- jmalin -dot- com>]

I much prefer using italics. I know that italics aren't always the
greatest in computer-based documentation, they do work fine with a
monospace font that you would use for code. I think that enclosing the
word or phrase in angle brackets is more risky, particularly since
they're now commonly used for markup tags such as XML.

I think it's always more confusing to use characters as punctuation that
is not part of the actual string. How do you differentiate the
punctuation from actual characters? I have seen one too many
descriptions that give you a string in quotes, and then tell you to put
everything in except the quotes!

Hi Odile!

Joe Malin

Odile Sullivan-Tarazi wrote:
>
> A style question . . .
>
> When you are documenting variables in code, do you apply italics in
> addition to the code font, do you instead enclose the word or phrase
> in angle brackets, or do you do both?
>
> I'm trying to get a feel for general industry practice.
>
>
> Thanks!
>
>
> Odile
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> WebWorks ePublisher Pro for Word features support for every major Help
> format plus PDF, HTML and more. Flexible, precise, and efficient
> content delivery. Try it today! http://www.webworks.com/techwr-l
>
> Easily create HTML or Microsoft Word content and convert to any
> popular Help file format or printed documentation. Learn more at
> http://www.DocToHelp.com/TechwrlList
>
> ---
> You are currently subscribed to TECHWR-L as jmalin -at- jmalin -dot- com -dot- 
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/jmalin%40jmalin.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
> http://www.techwr-l.com/techwhirl/ for more resources and info.
>
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help 
format plus PDF, HTML and more. Flexible, precise, and efficient content 
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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