Wie vollständig zu deaktivieren javadoc-überprüfung mit checkstyle maven-plugin

möchte ich die Maven-Checkstyle-plugin mit einer benutzerdefinierten Konfiguration, die sagt, Checkstyle, um keine Warnung oder Fehler, die auf fehlende Javadoc. Gibt es eine Möglichkeit, dies zu tun?

InformationsquelleAutor Wim Deblauwe | 2014-05-26
  1. 11

    Nur ihn selbst gefunden. Vollständig ignorieren alle javadoc-überprüfung für alles, fügen Sie diese zu Ihrem checkstyle-Konfiguration:

        <!-- No need for Javadoc -->
    <module name="JavadocType">
        <property name="severity" value="ignore"/>
    </module>
    <module name="JavadocMethod">
        <property name="severity" value="ignore"/>
    </module>
    <module name="JavadocVariable">
        <property name="severity" value="ignore"/>
    </module>
    • ... oder einfach nur entfernen Sie Module aus der Konfiguration komplett.
    • , Die offenbar nicht für mich arbeiten, es schien zu fallen, wieder auf die default-Konfiguration.
    • Sind Sie sicher, dass es funktioniert? Ich bekomme immer noch diese Fehler: (javadoc) JavadocVariable: Missing a Javadoc comment.
    InformationsquelleAutor Wim Deblauwe
  2. 3

    Eine gute option wäre das konfigurieren eines Unterdrückung filter.

    Plugin-Konfiguration:

    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <!-- ... -->
  <build>
    <plugins>
      <!-- ... -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.17</version>
        <executions>
          <execution>
            <id>verify</id>
            <phase>verify</phase>
            <configuration>
              <encoding>UTF-8</encoding>
              <consoleOutput>true</consoleOutput>
              <failsOnError>true</failsOnError>
              <linkXRef>false</linkXRef>
              <suppressionsLocation>
                checkstyle-suppressions.xml
              </suppressionsLocation>
              <suppressionsFileExpression>
                checkstyle.suppressions.file
              </suppressionsFileExpression>
            </configuration>
            <goals>
              <goal>check</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  <!-- ... -->
</project>

    checkstyle-suppressions.xml Datei:

    <?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
     "-//Puppy Crawl//DTD Suppressions 1.0//EN"
     "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">

<suppressions>
  <suppress checks="Javadoc" files="."/>
</suppressions>

    Dann läuft

    $ mvn verify

    Nicht die Ausgabe aller Javadoc-bezogene Checkstyle Fehler.

    Viele andere Beispiele, die auf Unterdrückung Filter können gefunden werden in checkstyle-repository.

    • Sie möchten möglicherweise führen Sie maven-checkstyle-plugin im validate phase, weil es keinen Sinn macht, zu kompilieren etwas, dass dann später nicht passieren checkstyle.
    InformationsquelleAutor Matheus Santana
Schreibe einen Kommentar