> From: Brian Jones
>
> Paul Fisher <[EMAIL PROTECTED]> writes:
>
> > "John Keiser" <[EMAIL PROTECTED]> writes:
> >
> > > Also, I have a question about Float and Number, specifically the
> > > methods byteValue() and shortValue(). They are implemented in
> > > Number, calling intValue() and casting down. Is there a reason for
> > > this?
> >
> > Yes. byteValue() and shortValue() were added in JDK 1.1. To retain
> > compatibility with Java 1.0 programs, default implementations of
> > byteValue() and shortValue() were added.
> >
> > Please change your commenting style to conform to GNU standards. The
> > double stars on each line are terribly ugly.
>
Ugly's just stuff we aren't used to. I think it looks fine. I will,
however, change them to meet Sun standards (see below).
> single '*' for everything but the first part of the comment if it is
> to be included in javadoc (as in variable or class declaration).
>
> /**
> * comment
> */
>
> and
> /**
> hello world
> */
>
> doesn't look right to me in Java. I prefer Sun's method.
>
A single star on every line will be OK. No stars looks bad. Not
having the star on every line makes it harder to distinguish between
comments and code. Document navigation becomes easier when you can
distinguish between the two line-by-line.
I thought we had agreed to use Sun's standard for the Java side, rather
than GNU. We granted exceptions for brackets and indentation. We do,
however, need to actually decide at some point how indentation and
bracketing works.
Like Stuart said in his other email, we can (and probably should) wait
until we get a convert-to-sun-standard tool before requiring a standard.
IMO, our styles are too disparate right now to do it any other way. Might I
suggest that this convert-to-sun-standard tool also have the ability to
format doc-comments?
I have been thinking about something creating something like this,
anyway. In addition to checking style, it can check to make sure, for
example, that any public methods have doc-comments and that they have
@return, @param, and @exception tags where required. Probably an extension
of an existing JavaDoc parser would be best, if we find out there are any.
--John
