Re: Riddle Me This

[Bruce Byfield <bbyfield -at- axionet -dot- com>]

Geoff Lane wrote:
> 
> Bruce Byfield wrote:
> >
> > I don't think that anyone would bother inventing their own
> > names in API
> > documentation. Would they?
> ---
> 
> Emphatically yes, I "invent" my own names. When I write API docs, I tend to
> write my own examples -- SMEs are usually far too busy to worry about such
> trivia. If you don't follow the naming conventions of the programming
> language for your variables, constants, and so on, your docs get less
> respect from the programming community (your target audience).
> 

I was referring to names for parts of the code: expressions, statements,
and so on.

-- 
Bruce Byfield 604.421.7177 bbyfield -at- axionet -dot- com

"Down at the river one day waits the ghost
Turning into the people that we hide from the most."
-Rev Hammer, "Drunkard's Waltz"

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

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com


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