Hausaufgaben und Gradle: Deaktivieren von Checkstyle und Spotless in den Vorgaben (B01 .. B06)

[cagix]

In den Vorgaben für die Übungsblätter ist i.d.R. eine einfache Gradle-Konfiguration enthalten, die u.a. auch Checkstyle (Prüfung auf Javadoc) und Spotless (Prüfung und Formatierung von Code) aktiviert. Da beim build i.d.R. auch ein check durchlaufen wird, gibt es bei fehlerhaftem Javadoc und/oder nicht angepasster Formatierung entsprechende Fehlermeldungen von Gradle.

Checkstyle

Für die Blätter 01 bis 06 ist die Einhaltung der Javadoc-Vorgaben nicht zwingend notwendig, da wir Javadoc in diesem Semester erst in Woche 09 besprechen. Ihr könnt dazu einfach das Plugin für Checkstyle in der Gradle-Konfiguration entfernen:

1. Die Einbindung des Plugins entfernen (die Zeile id 'checkstyle' im Abschnitt plugins löschen)
2. Die Konfiguration des Plugins löschen (die Zeilen checkstyle { ... }, weiter unten im build.gradle)

Spotless

Ich würde empfehlen, den eigenen Code kurz mit einem ./gradlew spotlessApply (oder über das entsprechende Menü in der IDE - versteckt in der Kategorie verification) zu formatieren. Damit gewöhnt ihr euch früh daran, dass es in allen Projekten entsprechende Stylevorgaben gibt, die zwingend einzuhalten sind.

Wen der eingestellte Google-Style (ASOP-Variante) arg stört, der kann bis einschließlich Blatt 06 das Gradle-Plugin Spotless in der Gradle-Konfiguration der Vorgaben einfach deaktivieren (analog zum Vorgehen bei Checkstyle, s.o.).

Einhaltung der Style-Vorgaben verpflichtend ab Blatt 07

Ab Blatt 07 (also für Blatt 07, Blatt 08 und Blatt 09) ist das Einhalten der Javadoc-Richtlinien als auch des Code-Styles verpflichtend. Formulieren von Javadoc muss man einfach üben, und die Formatierung lässt sich quasi auf Knopfdruck herstellen ...