...
- General information: language, name, drescription and user notes of the rule.
- Configuration: characteristic, priority, effort and editable parameters of the rule.
- Tags: labels assigned to the rule.
- Extended information: benefits, drawbacks, remediation and configuration.
- References: external documentation about the rule that is worth reading about the rule.
- Relations: which rules are related to the current rule and which rules the current rule is related to. Please consider deactivating rules that are:
Deprecated: deprecated rules should be avoided in favor of the rules that deprecates them. Deprecated rules will not be maintained in newer versions of Kiuwan engine.
Generalized: some rules may be too specialized in certain situations. If Kiuwan provides a more general rule please consider activating the generalized rule, as it has a wider scope and may detect more defects/vulnerabilities.
Incompatible: a rule R1 is incompatible with a rule R2 in any of these situations: R1 causes similar violations to R2 or R1 looks for disagreeing defects/vulnerabilities with R2. You should decide which rule suits better your needs.
Code examples: how to violate the rule and how to repair the violation.
- Advanced information: owner of the rule, rule code, implementation class, engine, engine version, rule version, internal parameters, etc.
...