So machen Sie Checkstyle Ignorieren von fehlenden JavaDoc, wenn es eine bestimmte Annotation gibt

Question

Ich möchte die Checkstyle JavadocVariable Regel so anpassen, dass sie sich nicht über ein Feld mit einer @FindBy Annotation beschwert.

class Demo{ 

    @FindBy(id = "new-button") 
    public WebElement createButton; //<- no JavaDoc required because it is a field "injected" by selenium 

    public String otherField; //<- complain about missing Java doc 
} 

Aber ich habe keine Ahnung, wie dies in der checkstyle.xml-Datei angeben. Hat jemand eine Idee?

Dinge, die nicht in diesem Anwendungsfall funktioniert:

• Modifyng die geprüfte Klasse ist auch keine Lösung!
• SuppressWithNearbyCommentFilterwird nicht funktionieren, weil es sich um eine Anmerkung ist aber kein Kommentar

Answer 1

Ich kenne mehrere Lösungen, aber alle von ihnen erfordert zusätzliche Arbeit zu tun.

1. Implementieren eigene JavadocVariableCheck mit der Möglichkeit zu überspringen, wenn Annotation vorgesehen ist.
2. Implementierung check Filter (wie SuppressWarningsHolder + SuppressWarningsFilter aber mit Annotation-Unterstützung)
3. Oder einfachen Filter implementieren, die für @FindBy scannt und ignoriert zwei Linien nach.

Meine Lösung (die einfachste):

package org.aap.checks; 

import com.google.common.collect.Lists; 
import com.puppycrawl.tools.checkstyle.api.AuditEvent; 
import com.puppycrawl.tools.checkstyle.api.AutomaticBean; 
import com.puppycrawl.tools.checkstyle.api.FileContents; 
import com.puppycrawl.tools.checkstyle.api.Filter; 
import com.puppycrawl.tools.checkstyle.checks.FileContentsHolder; 

import java.lang.ref.WeakReference; 
import java.util.Collections; 
import java.util.Iterator; 
import java.util.List; 

public class SuppressWithAnnotationFilter 
     extends AutomaticBean 
     implements Filter { 

    public class Tag implements Comparable<Tag> { 
     private final int firstLine; 
     private final int lastLine; 

     public Tag(int firstLine, int lastLine) { 
      this.firstLine = firstLine; 
      this.lastLine = lastLine; 
     } 

     @Override 
     public int compareTo(Tag other) { 
      if (firstLine == other.firstLine) { 
       return lastLine - other.lastLine; 
      } 
      return (firstLine - other.firstLine); 
     } 

     public boolean isMatch(AuditEvent event) { 
      final int line = event.getLine(); 
      return line >= firstLine && line <= lastLine; 
     } 

     @Override 
     public final String toString() { 
      return "Tag[lines=" + firstLine + " to " + lastLine + "]"; 
     } 
    } 

    private final List<Tag> tags = Lists.newArrayList(); 
    private WeakReference<FileContents> fileContentsReference = 
      new WeakReference<FileContents>(null); 

    public FileContents getFileContents() { 
     return fileContentsReference.get(); 
    } 

    public void setFileContents(FileContents fileContents) { 
     fileContentsReference = new WeakReference<FileContents>(fileContents); 
    } 

    @Override 
    public boolean accept(AuditEvent event) { 
     if (event.getLocalizedMessage() == null) { 
      return true;  // A special event. 
     } 

     final FileContents currentContents = FileContentsHolder.getContents(); 
     if (currentContents == null) { 
      return true; 
     } 
     if (getFileContents() != currentContents) { 
      setFileContents(currentContents); 
      tagSuppressions(); 
     } 
     for (final Iterator<Tag> iter = tags.iterator(); iter.hasNext();) { 
      final Tag tag = iter.next(); 
      if (tag.isMatch(event)) { 
       return false; 
      } 
     } 
     return true; 
    } 

    private void tagSuppressions() { 
     tags.clear(); 
     final FileContents contents = getFileContents(); 

     String[] contentsLines = contents.getLines(); 
     for (int i = 0; i < contentsLines.length; i++) { 
      if (contentsLines[i].contains("@FindBy")) { 
       tags.add(new Tag(i+1, i+2)); 
      } 
     } 

     Collections.sort(tags); 
    } 
} 

Add resultierende Klasse in Classpath der Aufgabe dann in check checkstyle.xml Filter angeben:

<?xml version="1.0"?> 
<!DOCTYPE module PUBLIC 
    "-//Puppy Crawl//DTD Check Configuration 1.3//EN" 
    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> 
<module name="Checker"> 
    <module name="TreeWalker"> 
    .... 
    <!-- your Check goes here --> 
    <module name="org.aap.checks.SuppressWithAnnotationFilter"/> 
    .... 
    </module> 
</module>