hadoop-common-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "John Zhuge (JIRA)" <j...@apache.org>
Subject [jira] [Created] (HADOOP-13411) Checkstyle suppression by annotation or comment
Date Sun, 24 Jul 2016 06:16:20 GMT
John Zhuge created HADOOP-13411:
-----------------------------------

             Summary: 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


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-dev-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-dev-help@hadoop.apache.org


Mime
View raw message