On Tue, Jun 7, 2016 at 2:52 AM, sebb <seb...@gmail.com> wrote:

> On 7 June 2016 at 03:22, Gary Gregory <garydgreg...@gmail.com> wrote:
> > Why do some [net] Javadoc comments come in the form:
> >
> > /***
> >  ...
> > ***/
> >
> > Instead of the regular:
> >
> > /**
> >   ...
> >   */
>
> History.
>
> They still work, so why bother to fix them?
>

Because it's confusing. Hm, is there some special convention that I need to
know about here? Are these really public methods or some other super public
method that need to be mentioned in the site docs? Or who knows what. Why
do I have to waste time thinking about it ;-) Conventions are a good thing,
they allow you to _not_ spend time figuring something out. Because the
Javadoc syntax allows it does not make it a good thing IMO.

Gary


> > ?
> >
> > Thank you,
> > Gary
> >
> > --
> > E-Mail: garydgreg...@gmail.com | ggreg...@apache.org
> > Java Persistence with Hibernate, Second Edition
> > <http://www.manning.com/bauer3/>
> > JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
> > Spring Batch in Action <http://www.manning.com/templier/>
> > Blog: http://garygregory.wordpress.com
> > Home: http://garygregory.com/
> > Tweet! http://twitter.com/GaryGregory
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
> For additional commands, e-mail: dev-h...@commons.apache.org
>
>


-- 
E-Mail: garydgreg...@gmail.com | ggreg...@apache.org
Java Persistence with Hibernate, Second Edition
<http://www.manning.com/bauer3/>
JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
Spring Batch in Action <http://www.manning.com/templier/>
Blog: http://garygregory.wordpress.com
Home: http://garygregory.com/
Tweet! http://twitter.com/GaryGregory

Reply via email to