Representing variables

Subject: Representing variables
From: Odile Sullivan-Tarazi <odile -at- mindspring -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 30 Oct 2006 15:16:05 -0800


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


Follow-Ups:

Previous by Author: re: Dangers of spellcheck
Next by Author: RE: PDF maker recommendations needed
Previous by Thread: RE: Pet Peeve: Nouns used as Verbs
Next by Thread: Re: Representing variables


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


Sponsored Ads