RE: API Documentation

Subject: RE: API Documentation
From: "walden miller" <wmiller -at- vidiom -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 31 Oct 2000 12:15:09 -0700

When to spell out numbers is probably the least of your problems if you are
reading code.
Make a rule and stick to it. here are the three rules I use:
1. all numbers when used with units in numeric format (e.g., 16 bit, 56K
baud, 3 bits)
2. all integers above nine and below 1 are always in numeric format;
otherwise spell them out.
3. all fractions are put into decimal format (e.g., not 3/4 but 0.75)

it really doesn't make any difference, but a rule takes the indecision away
so you can concentrate on other things that are important in API docs.

walden miller
vidiom systems



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn how to develop HTML-based Help with Macromedia Dreamweaver!
Dec. 7-8, 2000, Orlando, FL -- $100 discount for STC members.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Your web site localized into 32 languages? Maybe not now, but sooner than
you think. Download ForeignExchange's FREE paper, "3 steps to successful
translation management" at http://www.fxtrans.com/3steps.html?tw.

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


Previous by Author: RE: A title please.....
Next by Author: RE: In Reference to Drug Testing
Previous by Thread: API Documentation
Next by Thread: RE: API Documentation


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


Sponsored Ads