API Reference
Class
AnalysisRule
Describes a single analyzer rule and its metadata.
Inheritance
- Object
- AnalysisRule
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property AnalysisCatalog.Rules
- Property AnalysisPolicyRule.Rule
Accepted by parameters
- Constructor AnalysisCatalog.AnalysisCatalog
- Method AnalysisCatalog.TryGetRule
- Constructor AnalysisPolicyRule.AnalysisPolicyRule
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
Properties
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).