commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Emmanuel Bourg <ebo...@apache.org>
Subject Re: Javadoc formatting style
Date Mon, 07 Feb 2005 10:49:52 GMT
Or (c)

/**
  * This is the first paragraph.
  *
  * <p>And this is the second.</p>
  */

and (d)

/**
  * This is the first paragraph.<br>
  * <br>
  * And this is the second.
  */

I tend to use the (c) style, because most of the time the documentation 
consists in only one paragraph and I don't like to overload the doc with 
<p></p>.

Emmanuel Bourg


Simon Kitching wrote:
> Hi All,
> 
> 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


Mime
View raw message