commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Stephen Colebourne" <scolebou...@btopenworld.com>
Subject Re: Javadoc formatting style
Date Mon, 07 Feb 2005 00:03:15 GMT
[lang] uses the first. [collections] uses the second.

I prefer the second as IMHO it is more readable when you are browsing the 
source code. And I definitely read the javadoc in source code form more than 
I read it in html form.

Stephen

----- Original Message ----- 
From: "Simon Kitching" <skitching@apache.org>
> I have seen two basic approaches to applying formatting to javadoc text
> in source files:
>
> (a) XHTML-style
>  /**
>   *<p>This is the first paragraph.</p>
>   *
>   *<p>And this is the second.</p>
>   */
>
> (b) HTML-style
>  /**
>   * This is the first paragraph.
>   * <p>
>   * And this is the second.
>   */
>
> I would certainly like to pick one or the other for Digester2. What
> conventions have other commons projects adopted? Are there any good
> reasons to pick one over the other?
>
> Thanks,
>
> Simon
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
> 


---------------------------------------------------------------------
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