On Monday, May 16, 2011 1:22:43 PM UTC-4, Greg Dougherty wrote:
>
> It's too bad that there a 2 valid comments, and 34 worthless ones.
>
> Might I suggest that the GWT "Coding Standards" would do well to focus
> on requiring people to write readable and understandable code (which
> means having comments that explain what you're doing and why), rather
> than merely obsessing on whether people use tabs or spaces?
>
See the TODO at the beginning of PredefinedFormat -- patches welcome.
The *_{SHORT,MEDIUM,LONG,FULL} formats are harder to describe the other
formats like the ISO_8601 and RFC_2822 formats, since they will vary
significantly across locales. Basically, for these we just use whatever
those are defined as in CLDR. AFAIK, there is no documentation on exactly
what the criteria are for those lengths, which means the Javadoc that would
go there would be either "A short date format" or "The CLDR short date
format", which doesn't seem more useful than the name itself which is why it
hasn't been written yet.
The other predefined formats, which are also derived from CLDR data via
ICU4J, seem self-explanatory. Is there really much value in a Javadoc for
the HOUR_MINUTE_SECOND format that says "A format containing the hour,
minute, and second"?
Regarding the overall quality of doc in the GWT codebase, my personal
experience is that it is far better than most open-source projects -- of
course it can always be improved and anyone can submit such improvements.
As always, there is a limited amount of hours in the day and decisions must
be made on where to spend that time.
--
You received this message because you are subscribed to the Google Groups
"Google Web Toolkit" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/google-web-toolkit?hl=en.
