Regeln
In der Registerkarte Regeln können Sie die Regeln konfigurieren, die bei der Durchführung der Statischen Analyse berücksichtigt werden. Die Regeln werden in den Projekteigenschaften als Baumstruktur angezeigt. Teilweise sind einige Regeln unterhalb von organisatorischen Knoten angeordnet.
Mithilfe der Regeln werden Sie auf möglicherweise unbeabsichtigte und fehlerhafte Implementierungen hingewiesen, sodass Sie diese Programmstellen frühzeitig optimieren können.
Für die Regeln stehen bis zu drei Konfigurationsmöglichkeiten zur Verfügung:
1. Konfiguration der Regelaktivität
Sie können die einzelnen Regeln über das Kontrollkästchen der jeweiligen Zeile aktivieren oder deaktivieren. Wenn Sie das Kontrollkästchen eines Unterknotens auswählen, wirkt sich dies auf alle Einträge unterhalb dieses Knotens aus. Wenn Sie das Kontrollkästchen des obersten Regeln-Knotens auswählen, wirkt sich dies auf alle Einträge der Liste aus. Die Einträge unterhalb eines Knotens werden durch Mausklick auf das Minus- bzw. Pluszeichen vor dem Knotentitel zu- bzw. aufgeklappt.
Die Nummer in Klammern hinter jeder Regel, zum Beispiel "Unerreichbarer Code (1)", ist die Regelnummer, die bei einer Nichteinhaltung der Regel ausgegeben wird, z.B. "SA0001".
Es gibt die drei folgenden Einstellungen, zwischen denen Sie durch wiederholtes Klicken auf das Kontrollkästchen wechseln können:
: Die Regel wird nicht geprüft.
: Eine Regelverletzung wird als Fehler im Meldungsfenster ausgegeben.
: Eine Regelverletzung wird als Warnung im Meldungsfenster ausgegeben.
2. Konfiguration des Precompile-Verhaltens
Die meisten Regeln vom Static Analysis können bereits während der Vorkompilierung (Precompile) geprüft werden. Ob Sie das Ergebnis dieser Überprüfung als Precompile-Nachricht im Meldungsfenster ausgegeben bekommen möchten, können Sie über die folgenden Optionen konfigurieren.
- Generelle Option: „Meldung von Precompile-Nachrichten im Allgemeinen aktivieren“
- Default: deaktiviert
- Der Default-Wert der Option bedeutet, dass ab TwinCAT 3.1.4026.20 standardmäßig keine Precompile-Meldungen der Static Analysis Regeln im Meldungsfenster angezeigt werden.
- Wenn Sie Precompile-Meldungen der Regeln ausgegeben bekommen möchten, aktivieren Sie die o. g. Option.
- Regel-spezifische Option: „Precompile“
- Zusätzlich zu der generellen Aktivierung von Precompile-Meldungen können Sie pro Regel einstellen, ob diese als Precompile-Meldung ausgegeben werden soll.
- Diese Option steht nur für die Regeln zur Verfügung, die während der Vorkompilierung geprüft werden können. Eine Liste dieser Regeln finden Sie unter Precompile/QuickFix.
Durch die beiden genannten Optionen können Sie somit zum einen konfigurieren, ob Sie überhaupt Precompile-Meldungen ausgegeben bekommen möchten. Wenn ja, können Sie zum anderen detailliert einstellen, für welche Regeln dies gelten soll.
Folglich werden für eine bestimmte Regel nur dann Precompile-Meldungen ausgegeben, wenn die folgenden Voraussetzungen erfüllt sind:
- Option „Meldung von Precompile-Nachrichten im Allgemeinen aktivieren“ = aktiviert
- Die Regelüberprüfung ist aktiv (als Fehler oder Warnung)
- Option „Precompile“ der Regel = aktiviert
3. Konfiguration von Regel-Parametern/-Limits
Einige Regeln sind parametrierbar, sodass beispielsweise Grenzen individuell eingestellt werden können. Die Parameter, die bei der jeweiligen Prüfung berücksichtigt werden sollen, können Sie konfigurieren, indem Sie innerhalb der Regelkonfiguration auf die Zeile der entsprechenden Regel doppelklicken (SPS-Projekteigenschaften > Kategorie "Static Analysis" > Registerkarte "Regeln"). In dem aufgehenden Dialog können Sie die Regelparameter einstellen. Die aktuell konfigurierten Parameter werden in der "Limits"-Spalte der Regelkonfiguration angezeigt.
Eine Übersicht der parametrierbaren Regeln finden Sie auf der folgenden Seite: Regeln - Übersicht und Beschreibung
Weitere Informationen:
Syntax von Regelverletzungen im Meldungsfenster
Jede Regel besitzt eine eindeutige Nummer (in der Konfigurationsansicht der Regeln in runden Klammern hinter der Regel dargestellt). Wenn während der Statischen Analyse die Verletzung einer Regel festgestellt wird, wird die Nummer zusammen mit einer Fehler- bzw. Warnungsbeschreibung gemäß folgender Syntax im Meldungsfenster ausgegeben. Die Abkürzung "SA" weist dabei auf "Static Analysis" hin.
Syntax: "SA<Regelnummer>: <Regelbeschreibung>"
Beispiel für Regelnummer 33 (Nicht verwendete Variablen): "SA0033: Nicht verwendet: Variable 'bSample'"
Temporäre Deaktivierung von Regeln
Regeln, die hier im Dialog aktiviert sind, können über ein Pragma im Projekt temporär abgeschaltet werden. Weiterführende Informationen hierzu finden Sie unter Pragmas und Attribute.
Übersicht und Beschreibung der Regeln
Eine Übersicht der Regeln sowie eine detaillierte Beschreibung der Regeln finden Sie unter Regeln - Übersicht und Beschreibung.