Re: Terminolgy: the verb corresponding to "toString"
- From: Daniel Pitts <newsgroup.spamfilter@xxxxxxxxxxxxxxxxxxx>
- Date: Thu, 31 Jul 2008 09:35:50 -0700
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"
* Returns a String representation of this object.
* ${detailsOfStringFormatIfApplicable}
* ${warningAboutDetailsChangingInFutureIfApplicable}
* @returns a String suitable for (debugging, parsing, sending, etc...)
*/
--
Daniel Pitts' Tech Blog: <http://virtualinfinity.net/wordpress/>
.
- References:
- Terminolgy: the verb corresponding to "toString"
- From: Roedy Green
- Terminolgy: the verb corresponding to "toString"
- Prev by Date: Re: Apache Tomcat 6.0.18
- Next by Date: Re: Selector.select() won't work on MacOS X (JVM 1.6.0_05)
- Previous by thread: Re: Terminolgy: the verb corresponding to "toString"
- Next by thread: Re: Terminolgy: the verb corresponding to "toString"
- Index(es):
Relevant Pages
|
