You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Brett Porter <br...@apache.org> on 2006/04/28 11:20:29 UTC
standardising TODOs
Hi,
Does anyone have any thoughts on standard marking for "TODO" elements?
Currently, I've got mine set up:
Important: (\bXXX\b.*|\bIMPORTANT\b.*|\btodo\b.*\!.*)
ie, a line with XXX, IMPORTANT, or TODO with an ! on the line (eg
TODO [!]: ...)
Normal: (?m)\btodo\b[^!?\n]*$
ie, any line with TODO that doesn't have an ! or an ? on it
Question to be answered: \btodo\b.*\?.*
ie, any line with TODO and an ? on it, eg:
// TODO: should this be negative?
IntelliJ highlights these as different icons/colours. I basically rank
anything with ! as having to be resolved before a release. We could
later introduce PMD/checkstyle rules to make sure these are gone.
What do others think? Should they also have author/dates?
We have quite a lot in our code, and I'd like to have a better
understanding of which ones should be addressed, if at all, and under
which timeframe.
- Brett
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: standardising TODOs
Posted by Jason van Zyl <ja...@maven.org>.
On 28 Apr 06, at 11:06 AM 28 Apr 06, Kenney Westerhof wrote:
> On Fri, 28 Apr 2006, Brett Porter wrote:
>
> For people not using IntelliJ this doesn't work.
> Eclispe has 3 default tags:
>
> XXX - severe problem, but might work in some/most cases
> FIXME - indicates a workaround/too simple solution and should be
> addressed
> before a release
> TODO - improvements
>
> Maybe we could map your 3 levels to those 3 keywords somehow? Then we
> don't need complex regular expressions.
Would be nice to come up with the categories, then map them as Kenney
suggests as lots of different tools may do different things. But it
would be nice to have enough information to be able to hook it up to
an issue tracking system or reporting mechanism. Say walk over the
sources and push a series of issues to JIRA and be able to link back
them.
>
> -- Kenney
>
>> Hi,
>>
>> Does anyone have any thoughts on standard marking for "TODO"
>> elements?
>>
>> Currently, I've got mine set up:
>>
>> Important: (\bXXX\b.*|\bIMPORTANT\b.*|\btodo\b.*\!.*)
>> ie, a line with XXX, IMPORTANT, or TODO with an ! on the line (eg
>> TODO [!]: ...)
>>
>> Normal: (?m)\btodo\b[^!?\n]*$
>> ie, any line with TODO that doesn't have an ! or an ? on it
>>
>> Question to be answered: \btodo\b.*\?.*
>> ie, any line with TODO and an ? on it, eg:
>> // TODO: should this be negative?
>>
>> IntelliJ highlights these as different icons/colours. I basically
>> rank
>> anything with ! as having to be resolved before a release. We could
>> later introduce PMD/checkstyle rules to make sure these are gone.
>>
>> What do others think? Should they also have author/dates?
>>
>> We have quite a lot in our code, and I'd like to have a better
>> understanding of which ones should be addressed, if at all, and under
>> which timeframe.
>>
>> - Brett
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>
> --
> Kenney Westerhof
> http://www.neonics.com
> GPG public key: http://www.gods.nl/~forge/kenneyw.key
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
Jason van Zyl
jason@maven.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: standardising TODOs
Posted by Kenney Westerhof <ke...@apache.org>.
On Fri, 28 Apr 2006, Brett Porter wrote:
For people not using IntelliJ this doesn't work.
Eclispe has 3 default tags:
XXX - severe problem, but might work in some/most cases
FIXME - indicates a workaround/too simple solution and should be addressed
before a release
TODO - improvements
Maybe we could map your 3 levels to those 3 keywords somehow? Then we
don't need complex regular expressions.
-- Kenney
> Hi,
>
> Does anyone have any thoughts on standard marking for "TODO" elements?
>
> Currently, I've got mine set up:
>
> Important: (\bXXX\b.*|\bIMPORTANT\b.*|\btodo\b.*\!.*)
> ie, a line with XXX, IMPORTANT, or TODO with an ! on the line (eg
> TODO [!]: ...)
>
> Normal: (?m)\btodo\b[^!?\n]*$
> ie, any line with TODO that doesn't have an ! or an ? on it
>
> Question to be answered: \btodo\b.*\?.*
> ie, any line with TODO and an ? on it, eg:
> // TODO: should this be negative?
>
> IntelliJ highlights these as different icons/colours. I basically rank
> anything with ! as having to be resolved before a release. We could
> later introduce PMD/checkstyle rules to make sure these are gone.
>
> What do others think? Should they also have author/dates?
>
> We have quite a lot in our code, and I'd like to have a better
> understanding of which ones should be addressed, if at all, and under
> which timeframe.
>
> - Brett
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
--
Kenney Westerhof
http://www.neonics.com
GPG public key: http://www.gods.nl/~forge/kenneyw.key
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org