commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Brent Worden" <br...@worden.org>
Subject RE: [math] Maven build and elements of style
Date Sat, 27 Sep 2003 19:22:54 GMT
> >
> > I replaced "@todo" with "TODO:" while fixing the JavaDoc warnings.
> > Questions:
> > - "TODO" (without colon), as recognized by Eclipse out-of-the-box,
> >  or "TODO:" (with colon)? I used the latter, more for aestethics.
> >  Will Maven recognize "TODO"?
> > - What about the "FIXME"? Replace with "TODO:"?
> >
>
> +1 on TODO as Eclipse uses out of the box. (because when creating a TODO
> with Eclipse it will be minus the ':').
>
> http://maven.apache.org/reference/plugins/javadoc/properties.html
>

I have no problems with either TODO or TODO: and dropping the use of @todo.
We lose the report generation, but since Eclipse (and other IDEs, I assume)
handles TODO the report loses a lot of its value.  Plus, Eclipse and TODO do
not have any location restriction where as Maven and @todo forces all
comments in javadoc segments.

>
> -Mark
>
> --
> Mark Diggory
> Software Developer
> Harvard MIT Data Center
> http://www.hmdc.harvard.edu
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>

Brent Worden
http://www.brent.worden.org


Mime
View raw message