Re: Terminolgy: the verb corresponding to "toString"
- From: Eric Sosman <esosman@xxxxxxxxxxxxxxxxxxxx>
- Date: Thu, 31 Jul 2008 08:22:11 -0400
Roedy Green wrote:
What is the tersest way to document a toString style method.
I would like to say something like this:
"displays" the width and height in both metric and imperial measure
But it does not display anything, just prepares for display.
I have seen people also use misleading terms like "show" and "print".
What do you use?
The best I can come up with is "format". Sun uses this is the
SimpleDateFormat class.
To me, "format" implies some sort of complicated masks or a choice of
layouts.
"prepare" is too vague.
Perhaps a phase "convert x to a string"
I've seen "stringize" used as a verb, but I don't like
it much. Besides, speakers of Q.E. will want to spell it
"stringise" and there'll be no end of fruitless debatez.
Something like "Converts this Thing to a String" or
"Renders this Thing as a String" or "Returns a String
representing this Thing" would suit me better.
--
Eric Sosman
esosman@xxxxxxxxxxxxxxxxxxxx
.
- Follow-Ups:
- Re: Terminolgy: the verb corresponding to "toString"
- From: Tom Anderson
- Re: Terminolgy: the verb corresponding to "toString"
- References:
- Terminolgy: the verb corresponding to "toString"
- From: Roedy Green
- Terminolgy: the verb corresponding to "toString"
- Prev by Date: Re: Mutually Recursive Generic Types
- Next by Date: ThreadPoolExecutor backport
- Previous by thread: Re: Terminolgy: the verb corresponding to "toString"
- Next by thread: Re: Terminolgy: the verb corresponding to "toString"
- Index(es):
Relevant Pages
|