These @todo's are good, I've been using them on my projects for a while.
In particular the ability to browse the html report and see that
package x.y.z or class a.b.c has 50 todo's give's an idea of what sort of
state of completion at implementation is in.
The thing to rememeber is that they only get caught by the ant task if
you put the @todo in the javadoc's at the start of the method/class. A lot of
the usage of FIXME in jboss is in particular snippets of a method.
e.g.
public void doSomething() {
try {
...
} catch (ImportantException e) {
//FIXME: How should we handle this.
}
}
Would need to be...
/**
* @todo How do we handle that ImportantException
*/
public void doSomething() {
try {
...
} catch (ImportantException e) {
// ???
}
}
If @todo are to be used 'you must specify @todo in the javadocs' should
be added to the coding standard.
On Wed, Feb 27, 2002 at 11:22:53AM -0500, David Jencks wrote:
> XDoclet has a nice feature that I think we should use. Put @todo tags in
> your javadacs and xdoclet will generate a nice html report like the tests
> report. This beats FIXME hands down.
>
> Here's and example of usage from xdoclet (which uses this feature on
> itself)
>
> /**
> * @author Jerome Bernard ([EMAIL PROTECTED])
> * @author Ara Abrahamian ([EMAIL PROTECTED])
> * @created 31 January 2002
> * @version $Revision: 1.4 $
> * @todo attributes - XXX: Does this need to be synchronized?
> * @todo ifIsGetterMethod, ifIsSetterMethod - TODO: There is a big
> overlap
> * here with stuff in ejb - have a look.
>
--
regards
Neale Swinnerton
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/jboss-development
