SonarQube Inline Comments Rule

Hallo,

bin gerade wiedermal dabei ein SonarQube Quality Profile zu konfigurieren, allerdings finde ich die Regel(n) nicht um Inline Kommentare zu melden… dachte sowas gab es mal.

Wer weiss was dazu?

Danke,

maki

Hängt natürlich von den installierten Plugins ab. Das CheckStyle-Plugin hat eine Trailing Comment Rule. Reicht die?

Danke musiKk!

Die reicht natürlich nicht, will jede Art von Inline Kommentar als “schlecht” darstellen.
Leider machen die Rules die ich gefunden habe meistens das Gegenteil, “zu wenig Kommentare”…

Also Inline-Comments komplett verbieten, halte ich persönlich auch für zu hart. Mich stören mehr Zeilen mit Code und Kommentar gemischt. Die genannte Rule ist, wie ich gerade gesehen habe, auch deprecated und durch squids TrailingCommentCheck zu ersetzen (die findet man nur, wenn man nach dem kompletten String sucht). Dort gibt es keine Möglichkeit mehr, gültige Zeichen vor dem Kommentar anzugeben. Das geht aber bei Checkstyle. Wenn Du also alles verbieten möchtest, dann hilft vielleicht ein entsprechendes Pattern in der format-Option (^.*$ oder so).

Es geht erstmal nicht ums „verbieten“, sondern darum, „schlechten Code“ zu finden.

Inline Kommentare deuten fast immer auf schlechten Code hin, weil sie ein Zugeständnis daran sind, dass der Code selber nicht aussagekräftig genug ist, sonst könnte man sich die Komentare ja sparen.

Da liegt fast immer daran, dass Methoden zu gross sind, weil sie „zu viel machen“, SRP, SoC etc. sind verletzt, das hat u.a. zur Folge dass die Tests sehr komplex werden, usw.

„Don’t comment bad code, rewrite it“, „Documenting bad code is a waste of time“ usw. kommen nicht von ungefähr.

Danke klingt interessant, werde ich mal probieren.
Dachte nur es müsste schon eine Regel für sowas grundsätzliches geben…

Hast du mal versucht, die Datei einfach neu zu erstellen? Manchmal hat Netbeans einfach einen “Knacks”.

war doch nur ein bot