[jira] [Updated] (HADOOP-13411) Checkstyle suppression by annotation or comment

["Wei-Chiu Chuang (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/HADOOP-13411?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Wei-Chiu Chuang updated HADOOP-13411:
-------------------------------------
    Fix Version/s: 3.0.0-alpha2
                   2.9.0

> Checkstyle suppression by annotation or comment
> -----------------------------------------------
>
>                 Key: HADOOP-13411
>                 URL: https://issues.apache.org/jira/browse/HADOOP-13411
>             Project: Hadoop Common
>          Issue Type: Improvement
>    Affects Versions: 3.0.0-alpha2
>            Reporter: John Zhuge
>            Assignee: John Zhuge
>            Priority: Minor
>             Fix For: 2.9.0, 3.0.0-alpha2
>
>         Attachments: HADOOP-13411.001.patch
>
>
> Suppress checkstyle audit events in a method or a section of code by annotation or comment. This can be achieved by checkstyle module {{SuppressWarningsFilter}}, {{SuppressionCommentFilter}}, and {{SuppressWithNearbyCommentFilter}}.
> Examples:
> {code}
>   @SuppressWarnings("checkstyle:parameternumber")
>   // More than 7 parameters
>   public Response putRoot(p1, p2, p3, p4, p5, p6, p7, p8)  {
>     ...
>   }
> {code}
> {code}
>   // CHECKSTYLE:OFF:ParameterNumber
>   // More than 7 parameters
>   private Response put(p1, p2, p3, p4, p5, p6, p7, p8)  {
>     ...
>   }
>   // CHECKSTYLE:ON:ParameterNumber
> {code}
> {code}
> private int [] array; // SUPPRESS CHECKSTYLE
> {code}



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

---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org