Inspection Profile
Inspections sind ein Linting-Feature der IntelliJ-IDEA. Eine Inspection bietet somit die Möglichkeit während des Programmierens auf einen stilistischen/methodischen Fehler aufmerksam zu machen. Die Verwendung von Lintern ist aus der Praxis nicht mehr wegzudenken und in manchen IDEs standardmäßig integriert, oder über Plugins verfügbar. In der IntelliJ-IDEA sind manche standardmäßig aktiviert und durch Profile konfigurierbar.
Im Folgenden wird ein Profil vorgestellt, dass speziell für die Verwendung in dieser Lehrveranstaltung erstellt wurde.
Wichtiges zu beachten
Da dieses Feature lediglich eine Unterstützung zur Vermeidung methodischer Abzüge ist, empfiehlt es sich die Lints erst intensiv zu bearbeiten, nachdem der Code funktional fertig ist.
Dieses Profil zielt darauf ab IntelliJ's Inspection Feature vollständig auszunutzen. Gemäß dem Prinzip "Mit Kanonen auf Spatzen schießen" sind alle richtlinienrelevanten Inspections aktiviert, um das Potenzial einen möglichen Fehler zu erkennen, größtmöglich auszunutzen. Dies bedeutet insbesondere, dass nicht jede angeschlagene Inspection immer behoben werden muss. Sie sind Heuristiken, die auf einen möglichen Fehler aufmerksam machen. Die Prüfung, ob die angemerkte Stelle tatsächlich behoben werden muss, ist Aufgabe des Programmierers und wird hierdurch nicht abgenommen.
Oft werden Quick Fixes, über das Kontextmenü an einer angemerkten Code Stelle, angeboten, die den Fehler zu beheben versuchen. Diese Korrekturvorschläge sind von IntelliJ vordefiniert und entsprechend ebenso kritisch zu beurteilen, wie die Relevanz der angeschlagenen Inspection selbst.
Zudem stellt dieses Profil selbst in keiner Weise übliche Methodiken dar, wie sie in der Industrie/Praxis angewandt werden würden. Der Fokus liegt hierbei ausschließlich auf der Verwendung in dieser Lehrveranstaltung.
Fehlerkategorien
Die erzeugte Fehlerhervorhebung ist unterteilt in drei Arten, welche hierfür ausgenutzt werden, um Kategorien einzuführen, die die Schwere des Fehlers einschätzen.
Error Warnings
Error Warnings sind rot unterstrichen und deuten auf einen Fehler hin, der mit großer Wahrscheinlichkeit behoben werden sollte. Zu beachten ist hier, dass Compiler Fehler auf die gleiche Art hervorgehoben werden und somit nicht mehr auf Anhieb unterscheidbar sind.
Warnings
Warnings sind gelb hinterlegt und zeigen insbesondere Code Stellen auf, die IntelliJ standardmäßig anmerken würde. Die Notwendigkeit darauf reagieren zu müssen ist eher nicht zu erwarten, dennoch sind diese oft ein Zeichen von schlechtem Stil, den man lieber vermeiden würde.
Weak Warnings
Weak Warnings sind gelb unterstrichen und eher als netter Hinweis gedacht, dass hierfür wahrscheinlich eine geschicktere Alternative existiert.
Importieren des Profils
Zur Verfügung stehen zwei Varianten, die sich lediglich in der Aktivierung der JavaDoc Inspections unterscheiden.
Laden Sie das Profil mit allen richtlinienrelevanten Inspections und die Variante ohne JavaDoc Inspections herunter und importieren das Gewünschte nach den Bildanweisungen.