[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Representing variables

Subject: Re: Representing variables
From: Janice Gelb <janice -dot- gelb -at- sun -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 31 Oct 2006 17:05:28 +1100

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?


We use regular-font italic (as opposed to monospace
font italic, which we think is more difficult to read).
No angle brackets. We also encourage the use of hyphens
rather than underscores to separate a long variable name
because underscores often mean something in commands.

-- Janice

***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:

References:
Representing variables: From: Odile Sullivan-Tarazi

Previous by Author: Re: dangers of spellcheck
Next by Author: Re: Representing variables
Previous by Thread: Re: Representing variables
Next by Thread: Re: Representing variables

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads