Ich möchte, dass checkstyle javadoc nur für Klassen validiert, wenn es vorhanden ist. Es werden also keine Warnungen angezeigt, dass der javadoc fehlt.
Für Javadoc-Methoden ist dies mit dem Parameter allowMissingJavadoc möglich, aber ich sehe keine Entsprechung für das JavadocType-Modul.
Vielen Dank!
Antworten:
0 für die Antwort № 1Wenn Sie Eclipse mit dem Checkstyle-Plugin verwenden, gehen Sie wie folgt vor:
Bearbeiten Sie Ihr Checkstyle-Profil. Gehen Sie zu "Javadoc-Kommentare", wählen Sie "Method Javadoc" und klicken Sie auf "Öffnen". Dort gibt es viele Optionen für die Regel. Wenn Sie "allowMissingJavadoc" aktivieren, sollten Sie das tun, was Sie möchten.
Wenn Sie Checkstyle ohne Eclipse verwenden, sollte dies auch konfiguriert werden können. Ich bin damit nicht vertraut, aber das sollte Ihnen einen Hinweis geben, wonach Sie suchen müssen.
0 für die Antwort № 2
Für Javadoc-Methoden ist dies mit dem Parameter allowMissingJavadoc möglich, aber ich sehe keine Entsprechung für das JavadocType-Modul.
Dies ist momentan nicht mit dem aktuellen Checkstyle möglich. Es gibt keine solche Eigenschaft für JavadocType (http://checkstyle.sourceforge.net/config_javadoc.html#JavadocType) oder eine gute alternative Methode, um dies zu erreichen
Ich würde vorschlagen, dass Sie eine Feature-Anfrage an https://github.com/checkstyle/checkstyle/issues/new um die Umsetzung bitten.