[HADOOP-13411] Checkstyle suppression by annotation or comment

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.0.0-alpha2
• Fix Version/s: 2.9.0, 3.0.0-alpha2
• Target Version/s: 3.0.0-alpha2
• Hadoop Flags: Reviewed
• Assignee: John Zhuge
• Reporter: John Zhuge
• Created: 24/Jul/16 06:16
• Updated: 02/Oct/19 17:15
• Resolved: 16/Sep/16 21:18

Description

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:

  @SuppressWarnings("checkstyle:parameternumber")
  // More than 7 parameters
  public Response putRoot(p1, p2, p3, p4, p5, p6, p7, p8)  {
    ...
  }

  // CHECKSTYLE:OFF:ParameterNumber
  // More than 7 parameters
  private Response put(p1, p2, p3, p4, p5, p6, p7, p8)  {
    ...
  }
  // CHECKSTYLE:ON:ParameterNumber

private int [] array; // SUPPRESS CHECKSTYLE