Competitor for world's most useless JavaDoc "comment"

I was looking through com.google.gwt.i18n.client : Enum
DateTimeFormat.PredefinedFormat, because I wanted to figure out why my
dates were coming out in such a useless format (sorry, but while yyyy-
mm-dd is a lovely format if you want dates that can be textually
sorted by a computer, it's a crappy format if you want the dates read
by a human). So I clicked on the JavaDoc for DATE_SHORT. What did I
get?

public static final DateTimeFormat.PredefinedFormat DATE_SHORT

Wow, thank you. How completely useless. That doesn't even rise to
the lovel of "phoning it in."

I know the person responsible for DateTimeFormat.PredefinedFormat
knows how to write a reasonable JavaDoc, because it includes this:

RFC_2822

public static final DateTimeFormat.PredefinedFormat RFC_2822

RFC 2822 date format, fixed across all locales.
Example: Thu, 20 May 2010 17:54:50 -0700
http://tools.ietf.org/html/rfc2822#section-3.3

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?

Greg

--
You received this message because you are subscribed to the Google Groups "Google Web Toolkit" group.
To post to this group, send email to google-web-toolkit@googlegroups.com.
To unsubscribe from this group, send email to google-web-toolkit+unsubscribe@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/google-web-toolkit?hl=en.