From fbca8eb0ba5c10c7e7067d1f10541374b145479f Mon Sep 17 00:00:00 2001 From: Michal Kordas Date: Thu, 14 Jan 2016 07:40:22 +0100 Subject: [PATCH] #371 Prohibit multi-line comments in MethodBodyComments check --- .../com/qulice/checkstyle/MethodBodyCommentsCheck.java | 2 +- .../ChecksTest/MethodBodyCommentsCheck/Invalid.java | 8 ++++++++ .../ChecksTest/MethodBodyCommentsCheck/Valid.java | 4 ++++ .../ChecksTest/MethodBodyCommentsCheck/violations.txt | 7 +++++-- 4 files changed, 18 insertions(+), 3 deletions(-) diff --git a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodBodyCommentsCheck.java b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodBodyCommentsCheck.java index 4f60a5e07..03ff1a22c 100644 --- a/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodBodyCommentsCheck.java +++ b/qulice-checkstyle/src/main/java/com/qulice/checkstyle/MethodBodyCommentsCheck.java @@ -103,7 +103,7 @@ private void checkMethod(final String[] lines, final int start, final boolean oneliner = start == end - 1; for (int pos = start; pos < end; ++pos) { final String line = lines[pos].trim(); - if (line.startsWith("//")) { + if (line.startsWith("//") || line.startsWith("/*")) { final String comment = line.substring(2).trim(); if (!comment.startsWith("@checkstyle") && !oneliner) { this.log(pos + 1, "Comments in method body are prohibited"); diff --git a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Invalid.java b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Invalid.java index 844a2a0a0..794410f8a 100644 --- a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Invalid.java +++ b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Invalid.java @@ -7,12 +7,20 @@ public final class Invalid { * Comments. */ public Invalid(String name, String value) { + /* Comments */ int i; // Comments } public void print(String format, String text) { // Comments int c = 0; + /* Comments */ + } + + public int invalidCommentInside() { + final int first = 1; +/* invalid comment */ final int second = 2; + return first + second; } } diff --git a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Valid.java b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Valid.java index fbcbd56b4..ad89015aa 100644 --- a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Valid.java +++ b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/Valid.java @@ -50,4 +50,8 @@ public interface ValidInterface { * Some method with no body */ void method(); + + /* Some plain comment outside method*/ + void method(); + /* Another plain comment outside method */ } diff --git a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/violations.txt b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/violations.txt index fdecfd939..398d81e39 100644 --- a/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/violations.txt +++ b/qulice-checkstyle/src/test/resources/com/qulice/checkstyle/ChecksTest/MethodBodyCommentsCheck/violations.txt @@ -1,2 +1,5 @@ -11:Comments in method body are prohibited -14:Comments in method body are prohibited +10:Comments in method body are prohibited +12:Comments in method body are prohibited +15:Comments in method body are prohibited +17:Comments in method body are prohibited +22:Comments in method body are prohibited