[
https://issues.apache.org/jira/browse/HADOOP-13411?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
John Zhuge updated HADOOP-13411:
--------------------------------
Attachment: HADOOP-13411.001.patch
Patch 001
* Add checkstyle module {{SuppressWarningsFilter}},
{{SuppressionCommentFilter}}, and {{SuppressWithNearbyCommentFilter}} to
{{checkstyle.xml}}
If you'd like to test the patch, apply the patch, then run {{mvn install}} in
directory {{hadoop-build-tools}} first before running any {{mvn
checkstyle:checkstyle}}.
> 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
> 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: [email protected]
For additional commands, e-mail: [email protected]