Added reporting & updating documentation.

2024-05-09 22:30:15 +02:00
parent d836e46a71
commit bbb7205095
13 changed files with 607 additions and 72 deletions
@@ -0,0 +1,74 @@
+# SpotBugs
+
+## Verwendung der "null" Annotations
+
+In Java-Projekten ist es wichtig, potenzielle NullPointer-Exceptions zu
+vermeiden, die durch den unsachgemäßen Umgang mit Null-Werten entstehen
+können. Die Null Annotations von JetBrains bieten eine praktische Lösung,
+um solche Probleme frühzeitig im Code zu erkennen und entsprechende Warnungen
+über Tools wie Spotbugs zu erhalten.
+
+### Abhängigkeit
+Die notwendigen Annotations sind u.a. in der Library von JetBrains
+```xml
+<dependency>
+    <groupId>org.jetbrains</groupId>
+    <artifactId>annotations</artifactId>
+    <version>${jetbrains.annotations.version</version>
+    <scope>compile</scope>
+</dependency>
+```
+
+### Verwendung der Annotations im Code
+Nachdem die Bibliothek in deinem Projekt verfügbar ist, kannst du die 
+Annotations **@Nullable** und **@NotNull** verwenden, um anzugeben, ob eine
+Methode oder Variable Null-Werte akzeptieren darf oder nicht.
+
+#### @NotNull
+Die @NotNull Annotation wird verwendet, um anzugeben, dass ein Parameter,
+eine lokale Variable, ein Feld oder eine Methode niemals den Wert null
+annehmen sollte. Dies ist besonders wichtig in Methoden, die keine null
+Werte verarbeiten können, da es andernfalls zu einer NullPointerException
+führen könnte. Durch die Anwendung dieser Annotation kann deine
+Entwicklungsumgebung oder ein statischer Code-Analyse-Tool wie SpotBugs oder
+IntelliJ IDEA's integrierter Inspektor dich warnen, wenn es eine potenzielle
+Verletzung dieser Bedingung gibt.
+
+**Anwendungsbeispiele für @NotNull:**
+- Methodenparameter: Garantiert, dass übergebene Argumente nicht null sind.
+- Methodenrückgabetyp: Stellt sicher, dass die Methode keinen null Wert zurückgibt.
+- Felder: Verhindert, dass Klassenfelder auf null gesetzt werden.
+
+#### @Nullable
+Die @Nullable Annotation wird verwendet, um zu kennzeichnen, dass eine
+Variable, ein Parameter, ein Feld oder eine Methode null zurückgeben oder
+null akzeptieren kann. Diese Annotation ist nützlich, um klarzustellen, dass
+Methoden und Variablen sicher für den Umgang mit Nullwerten sind. Wenn eine
+Variable oder Methode als @Nullable gekennzeichnet ist, sollten Entwickler
+entsprechende Null-Checks durchführen, um NullPointerExceptions zu vermeiden.
+
+**Anwendungsbeispiele für @Nullable:**
+- Methodenparameter: Erlaubt explizit, dass übergebene Argumente null sein können.
+- Methodenrückgabetyp: Gibt an, dass die Methode möglicherweise null zurückgibt, und fordert den Aufrufer auf, dies zu überprüfen.
+- Felder: Erlaubt, dass Klassenfelder auf null gesetzt werden können.
+
+### Allgemeine Richtlinien
+**Konsistente Verwendung**: Es ist wichtig, diese Annotationen konsistent im
+gesamten Code zu verwenden, um ihre Effektivität zu maximieren. 
+Inkonsistenzen können zu Fehlinterpretationen und Fehlern führen.
+**Integration mit Tools**: Nutze Entwicklungswerkzeuge und statische 
+Code-Analyse-Tools, die diese Annotationen erkennen und respektieren 
+können, um die Sicherheit deines Codes zu erhöhen.
+**Dokumentation und Team-Kommunikation**: Stelle sicher, dass alle 
+Teammitglieder die Bedeutung und den korrekten Einsatz dieser Annotationen
+verstehen. Dies verbessert die Code-Qualität und verhindert Fehler in der
+Zusammenarbeit.
+
+Durch den durchdachten Einsatz von @NotNull und @Nullable kannst du die Robustheit deines Codes signifikant steigern und sicherstellen, dass deine Anwendungen weniger anfällig für Laufzeitfehler durch unerwartete Null-Werte sind.
+
+## Ergebnis der Analyse
+
+Das Ergebnis der Analyse findet sich nach der Überprüfung in target/spotbugsXml.xml.
+
+Um die Datei besser lesen zu können, sollte man sich die Datei einfach
+von der Entwicklungsumgebung formatieren lassen.