ExportCodeAnalysisRuleAttribute.Description プロパティ

定義

ルールの説明。 これは、ルールが警告またはブロックすることを意図している内容を人間が判読できる短い説明にする必要があります。 このフィールドはローカライズ可能ですが、これは ExportCodeAnalysisRuleAttribute サブクラス化して Description プロパティをオーバーライドする必要があります。

public virtual string Description { get; set; }
member this.Description : string with get, set
Public Overridable Property Description As String

プロパティ値

// Example of an Attribute class that supports localized descriptions:
public class TestLocalizedExportCodeAnalysisRuleAttribute : ExportCodeAnalysisRuleAttribute
{
    private readonly string _descriptionResourceName;
    private string _descriptionValue;

    public TestLocalizedExportCodeAnalysisRuleAttribute(string id, string displayName, string descriptionResourceName)
        : base(id, displayName)
    {
        _descriptionResourceName = descriptionResourceName;
    }

    public override string Description
    {
        get
        {
            if (_descriptionValue == null)
            {
                // Using the descriptionResourceName as the key for looking up the description in the resources file. 
                // MyResources is a resource file in the same project as the LocalizedExportCodeAnalysisRuleAttribute class. 
                // For each rule, and entry should be added to the resources file with the descriptionResourceName as the
                // key and the description as the value
                _descriptionValue = MyResources.ResourceManager.GetString(_descriptionResourceName);
            }
            return _descriptionValue;
        }
    }
}

適用対象