API Reference
Class
AnalysisRule
Describes a single analyzer rule and its metadata.
Inheritance
- Object
- AnalysisRule
Constructors
public AnalysisRule(String id, String language, String tool, String toolRuleId, String title, String description, String category, String defaultSeverity, IReadOnlyList<String> tags, String docs, String sourcePath, String type = null) #Creates a new rule description.
Parameters
- id System.String
- language System.String
- tool System.String
- toolRuleId System.String
- title System.String
- description System.String
- category System.String
- defaultSeverity System.String
- tags System.Collections.Generic.IReadOnlyList{System.String}
- docs System.String
- sourcePath System.String
- type System.String = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public String Language { get; } #Language identifier for the rule.
public String Tool { get; } #Analyzer tool that owns the rule.
public String ToolRuleId { get; } #Tool-specific rule identifier.
public String Description { get; } #Rule description shown in UI.
public String DefaultSeverity { get; } #Default severity assigned by the pack.
public IReadOnlyList<String> Tags { get; } #Optional rule tags for grouping.
public String SourcePath { get; } #Source file path for the rule definition.
public String Type { get; } #Optional rule type classification (for example: bug, vulnerability, code-smell, security-hotspot).