[java] 특정 코드 줄에 대해 특정 체크 스타일 규칙을 비활성화하는 방법은 무엇입니까?

http://checkstyle.sourceforge.net/config_filters.html#SuppressionCommentFilter 에서 supressionCommentFilter 사용을 확인 하십시오 . checkstyle.xml에 모듈을 추가해야합니다

<module name="SuppressionCommentFilter"/>

구성 할 수 있습니다. 따라서 코드에 주석을 추가하여 체크 스타일을 끄고 (다양한 수준에서) 코드에서 주석을 사용하여 다시 다시 설정할 수 있습니다. 예 :

//CHECKSTYLE:OFF
public void someMethod(String arg1, String arg2, String arg3, String arg4) {
//CHECKSTYLE:ON

더 나은 방법은 다음과 같이 조정 된 버전을 사용하는 것입니다.

<module name="SuppressionCommentFilter">
    <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
    <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
    <property name="checkFormat" value="$1"/>
</module>

특정 코드 줄에 대한 특정 검사를 해제 할 수 있습니다.

//CHECKSTYLE.OFF: IllegalCatch - Much more readable than catching 7 exceptions
catch (Exception e)
//CHECKSTYLE.ON: IllegalCatch

* 참고 : 또한 다음을 추가해야합니다 FileContentsHolder.

<module name="FileContentsHolder"/>

또한보십시오

<module name="SuppressionFilter">
    <property name="file" value="docs/suppressions.xml"/>
</module>

SuppressionFilter동일한 페이지 의 섹션 아래에서 패턴 일치 자원에 대한 개별 검사를 해제 할 수 있습니다.

따라서 checkstyle.xml에있는 경우 :

<module name="ParameterNumber">
   <property name="id" value="maxParameterNumber"/>
   <property name="max" value="3"/>
   <property name="tokens" value="METHOD_DEF"/>
</module>

다음을 사용하여 억제 xml 파일에서 끌 수 있습니다.

<suppress id="maxParameterNumber" files="YourCode.java"/>

Checkstyle 5.7에서 사용 가능한 다른 방법은 @SuppressWarningsjava 주석을 통해 위반을 억제하는 것 입니다. 이렇게하려면 구성 파일에 두 개의 새 모듈 ( SuppressWarningsFilter및 SuppressWarningsHolder) 을 추가해야 합니다.

<module name="Checker">
   ...
   <module name="SuppressWarningsFilter" />
   <module name="TreeWalker">
       ...
       <module name="SuppressWarningsHolder" />
   </module>
</module> 

그런 다음 코드 내에서 다음을 수행 할 수 있습니다.

@SuppressWarnings("checkstyle:methodlength")
public void someLongMethod() throws Exception {

또는 여러 번 억제하는 경우 :

@SuppressWarnings({"checkstyle:executablestatementcount", "checkstyle:methodlength"})
public void someLongMethod() throws Exception {

NB : ” checkstyle:“접두어는 선택 사항입니다 (권장). 문서에 따르면 매개 변수 이름은 모두 소문자 여야하지만 실제로는 모든 경우가 작동 함을 나타냅니다.

답변

<module name="TreeWalker">
    <!-- Make the @SuppressWarnings annotations available to Checkstyle -->
    <module name="SuppressWarningsHolder" />
</module>

<!-- Filter out Checkstyle warnings that have been suppressed with the @SuppressWarnings annotation -->
<module name="SuppressWarningsFilter" />

<module name="TreeWalker">
...

@SuppressWarnings("checkstyle:methodlength")
@Override
public boolean equals(Object obj) {
    // very long auto-generated equals() method
}

Preferences:
  Java
  --> Compiler
  --> Errors/Warnings
  --> Annotations
  --> Unhandled token in '@SuppressWarnings': set to 'Ignore'

// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
public void onClick(View view) { ... }

<module name="SuppressWithNearbyCommentFilter">
    <property name="commentFormat" value="CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES"/>
    <property name="checkFormat" value="$1"/>
    <property name="influenceFormat" value="$2"/>
</module>

<module name="NoWhitespaceBefore"/>

@SuppressWarnings({"nowhitespacebefore"})

@SuppressWarnings({"NoWhitespaceBefore"})

<module name="NoWhitespaceBefore">
  <property name="id" value="nowhitespacebefore"/>
</module>

<module name="Checker">
    <module name="SuppressionCommentFilter"/>
    <module name="TreeWalker">
        <module name="FileContentsHolder"/>
    </module>
</module>

<module name="SuppressionCommentFilter">
  <property name="offCommentFormat" value="BEGIN GENERATED CODE"/>
  <property name="onCommentFormat" value="END GENERATED CODE"/>
</module>

//BEGIN GENERATED CODE
@Override
public boolean equals(Object obj) { ... } // No violation events will be reported

@Override
public int hashCode() { ... } // No violation events will be reported
//END GENERATED CODE