[jira] [Commented] (REEF-1112) Update TodoComment checkstyle check

["Sergey Dudoladov (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/REEF-1112?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15108572#comment-15108572 ] 

Sergey Dudoladov commented on REEF-1112:
----------------------------------------

{quote}
Our code often uses PREFIX (which is valid word) and xxx as part of string constant,
{quote}

AFAIK the regular expression in this check works only on comments.

I experimented with this setting
{code:xml}
<module name="TodoComment">
    <property name="format" value="XXX|FIX"/>
    <property name="severity" value="warning"/>
</module>
{code}

It nicely caught relevant comments (mostly in Tang); so far I haven't seen any false positives. The "FIX" pattern also catches the "FIXME".

Does this set up make sense ?

> Update TodoComment checkstyle check
> -----------------------------------
>
>                 Key: REEF-1112
>                 URL: https://issues.apache.org/jira/browse/REEF-1112
>             Project: REEF
>          Issue Type: Sub-task
>          Components: Build infrastructure, Documentation
>            Reporter: Sergey Dudoladov
>
> Currently, the [TodoComment check | http://checkstyle.sourceforge.net/config_misc.html#TodoComment]  catches only TODO tags. We should add other common tags such as FIXME, FIX and XXX. Suggested configuration add-on:
> {code:xml}
> <module name="TodoComment">
>     <property name="format" value="(TODO)|(FIXME)|(FIX)|(XXX)"/>
>     <property name="severity" value="warning"/>
> </module>
> {code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)