Terminolgy: the verb corresponding to "toString"
- From: Roedy Green <see_website@xxxxxxxxxxxxxxxxxxxx>
- Date: Thu, 31 Jul 2008 10:50:52 GMT
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"
--
Roedy Green Canadian Mind Products
The Java Glossary
http://mindprod.com
.
- Follow-Ups:
- Re: Terminolgy: the verb corresponding to "toString"
- From: Daniel Pitts
- Re: Terminolgy: the verb corresponding to "toString"
- From: bugbear
- Re: Terminolgy: the verb corresponding to "toString"
- From: RedGrittyBrick
- Re: Terminolgy: the verb corresponding to "toString"
- From: Eric Sosman
- Re: Terminolgy: the verb corresponding to "toString"
- From: Nigel Wade
- Re: Terminolgy: the verb corresponding to "toString"
- From: Andrea Francia
- Re: Terminolgy: the verb corresponding to "toString"
- Prev by Date: Re: Does "persist" mean *commit* ??
- Next by Date: Re: Terminolgy: the verb corresponding to "toString"
- Previous by thread: Performance issues with large ResultSet
- Next by thread: Re: Terminolgy: the verb corresponding to "toString"
- Index(es):
Relevant Pages
|