views:

64

answers:

2

In one project the use of //TODO, //XXX and //FIXME tags is very common.

The problem is that nobody has an overview of all TODO lines. Only Eclipse shows all tasks in one view.

I would like to display all TODOs with its filename in our daily build report created by CruiseControl.

How can this achieved easily?

+3  A: 

You could write a small script that "grep" for all //TODO tags in your soruce code files and prints a report. This script can then be called from ant so that the build output contains this report.

Rahul
-1: grep isn't able to distinguish the different locations of TODO tags like eclipse can do it. If you have a string containing your TODO tag somewhere in your code, grep would find it, creating a warning in your report.
tangens
I used the word "grep" in a generic way. You could always write your search string such that it ignores such possibilities. For ex. search for only uppercase TODO that start with // etc.
Rahul
@tangens: is it really often when you have `//TODO` in your Strings literals?
Grzegorz Oledzki
+2  A: 

You may be able to use checkstyle. But I'd look into this maven plugin. Maybe you can generate tag reports without migrating your build wholesale from ant.

martin clayton
Perfekt. I will try the checkstyle and the maven plugin. Both seem very nice.
furtelwart