Java - Führen Sie das CheckStyle-Plug-In in IntelliJ IDEA ein und spiegeln Sie es im Formatierer wider

Schreiben Sie keinen Code unter Berücksichtigung der CheckStyle-Definition und lassen Sie den Intelli IDEA-Formatierer den größten Teil der Arbeit erledigen.

Erstellen Sie checkstyle.xml

Erstellen Sie etwas, das im Projekt verwendet werden soll.

Einführung des IntelliJ IDEA Plug-Ins "CheckStyle-IDEA"

Verfahren

1. Öffnen Sie IntelliJ IDEA
2. Öffnen Sie die Einstellungen
3. Öffnen Sie PlugIns
4. Suchen Sie nach CheckStyle und wählen Sie "CheckStyle-IDEA"
5. Klicken Sie auf die Schaltfläche Installieren
6. Starten Sie IntelliJ IDEA neu
7. Checkstyle-Elemente werden zu den Einstellungen hinzugefügt

Bild

CheckStyle-Use checkstyle.xml Definition für IDEA

1. Öffnen Sie Checkstyle in den Einstellungen
2. Klicken Sie im Element Konfigurationsdatei auf die Schaltfläche +
3. Wählen Sie die oben erstellte Datei checkstyle.xml aus und geben Sie einen Namen ein
4. Die hinzugefügte Definition wird der Konfigurationsdatei hinzugefügt. Aktivieren Sie das Kontrollkästchen, um sie zu aktivieren.

Mit der obigen Arbeit können Sie jetzt den Code mit CheckStyle auf IntelliJ IDEA überprüfen.

Bild

Checkstyle-Einstellungen

Code-Check-Bildschirm von Checkstyle

Reflektieren Sie den Inhalt von checkstyle.xml im Code-Formatierer von IntelliJ IDEA

1. Einstellungen-> Editor-> Java öffnen
2. Klicken Sie auf die Zahnradmarkierung im Element Schema
3. Klicken Sie auf Importschema-> CheckStyle-Konfiguration
4. Wählen Sie die oben erstellte Datei checkstyle.xml aus
5. Der Inhalt des Formatierers entspricht checkstyle.xml
6. Wenn Sie das Format im Editor ausführen, wird es mit dem festgelegten Inhalt formatiert.

Wenn Sie sie mit einem Formatierer arrangieren, werden Sie mit CheckStyle kaum wütend. Der Inhalt von JavaDoc, z. B. keine nachfolgende Periode, wird vom Formatierer nicht formatiert, sodass nicht alle aufgelöst werden.

Bild

Zusammenfassung

Wenn Sie das Codeformat lose vereinheitlichen, brauchen Sie nicht viel, aber wenn Sie versuchen, zur Erstellungszeit auf der Fehlerstufe zu spielen, wird die Codierungsarbeit selbst eng. Wenn das Codeformat im Team nicht korrekt ist, entstehen Kosten für die Bestätigungsseite. Daher möchte ich so viel wie möglich automatisieren und den Teil reduzieren, der im Kopf verwaltet werden kann. Außerdem scheinen viele Open Source-Projekte heutzutage auf Google Java Style zu basieren. Wenn Sie etwas veröffentlichen, scheint es für andere Programmierer einfach zu sein, wenn Sie ihnen folgen.