commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Craig McClanahan <craig...@gmail.com>
Subject Re: Javadoc formatting style
Date Mon, 07 Feb 2005 02:59:15 GMT
On Sun, 6 Feb 2005 21:45:08 -0500, Henri Yandell <flamefew@gmail.com> wrote:
> My reason is quite a lot simpler than Craig's.
> 
> I think of <p> as a container tag and not a separator tag, so I never
> even think of the other way of doing it.
> 
> I guess we could do:
> 
> /**
>  * first
>  * <p/>
>  * second
>  */
> 
> and still be XML compliant (assuming an automatic root of some kind),
> but it would seem just as wrong to me.

It would be valid only if the element that the Javadoc doclet happens
to place around your Javadoc comments accepts mixed content, *AND* if
the nested content is itself well formed.  Java developers who count
on that are, IMHO, making a mistake.

Of course, I feel the same way about developers creating static HTML
pages that create non-well-formed markup :-).

Craig

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message