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: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]



Reply via email to