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 01:18:22 GMT
As should be evident from my own recent practice :-), I'm also +1 on
the first (XHTML) approach.

Craig


On Sun, 6 Feb 2005 17:15:48 -0800, Martin Cooper <mfncooper@gmail.com> wrote:
> On Sun, 6 Feb 2005 19:46:30 -0500, Henri Yandell <flamefew@gmail.com> wrote:
> > However, the point of javadoc is to put it in HTML, and using the
> > latest version of HTML (ie XHTML) seems like the thing to do.
> >
> > Otherwise we could just ignore the <p>'s all together and make it look
> > even better for source reading.
> >
> > +1 to the first :)
> 
> I am also +1 on the first (XHTML) option.
> 
> --
> Martin Cooper
> 
> 
> > Hen
> >
> > On Mon, 7 Feb 2005 00:03:15 -0000, Stephen Colebourne
> > <scolebourne@btopenworld.com> wrote:
> > > [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 -----
> > > Wrom: WTQTIPWIGYOKSTTZRCLBDXRQBGJSNBOHMKHJYFM
> > > > 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
> > >
> > >
> >
> > ---------------------------------------------------------------------
> > 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
> 
>

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