Re: Class name formatting

Subject: Re: Class name formatting
From: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 16 Oct 2020 09:36:40 +0000 (UTC)

What formatting do you use when you document your relatives? Auntie Jane, in a plain language reference, would be "Your auntie, Jane." Same thing here. The class tmZone is a class for time zones. In other words, it is a time zone class.
In this case, "time zone" is not a name. So you don't need any formatting at all. OTOH, I don't think I ever use that approach, unless there are many time zone classes, and I need to talk about them as a group. I always try to refer to a class or any other programming construct by its proper name, usually wrapped in <codeph>.
cud

From: Deanna Korth <deanna -dot- korth -at- gmail -dot- com>What formatting do you use when you document the plain language name of a
class? For example, if the class name is tmZone, what formatting do you use
when you're writing about the "time zone" class?


------------------------------


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

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

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Next by Author: Class name formatting
Previous by Thread: Re: Class name formatting
Next by Thread: Re: Class name formatting


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


Sponsored Ads