Есть ли способ сказать FxCop, что тип должен быть неизменным?

Question

У меня есть тип, который содержит коллекцию постоянных данных. Константы определяются стандартом, который определяется вне моей программы. Тип выглядит следующим образом:

public class IAmImmutable 
{ 
    public IAmImmutable(string member1, string member2) 
    { 
     this.Member1 = member1; 
     this.Member2 = member2; 
    } 

    public string Member1 { get; private set; } 

    public string Member2 { get; private set; } 

    public static readonly Instance1 = new IAmImmutable("abc", "def"); 
    public static readonly Instance2 = new IAmImmutable("example", "data"); 
    public static readonly Instance3 = new IAmImmutable("for", "stackoverflow"); 
    public static readonly Instance4 = new IAmImmutable("these are", "constant fields"); 
    public static readonly Instance5 = new IAmImmutable("42", "1729"); 
    /* ... */ 
    public static readonly Instance1000 = new IAmImmutable("HUNGRY EVIL", "ZOMBIES"); 
} 

Это приводит к тысячам CA2104:DoNotDeclareReadOnlyMutableReferenceTypes обнаружений от FxCop. Примечания в этом обнаружении указывают на то, что следует подавлять обнаружение, если указанный тип является неизменным, что в этом случае. Тем не менее, я не хочу иметь тысячи и тысячи подавлений, если я могу избежать этого.

Можно ли пометить этот тип неизменным и, следовательно, предотвратить это обнаружение?

Answer 1

См. Статью, объясняющую, как это сделать на MSDN.

Похоже, что FxCop ищет текстовый файл с именем ImmutableTypes.txt для типов, которые он должен считать «неизменяемыми».

Для чего это необходимо, ваш класс IS изменен изнутри, даже если вы его явно не изменяете. Одно из изменений, которые бы сделать это неизменным, чтобы изменить свойство из автоматического реализуемого, чтобы получить свойства только подкрепленные только для чтения полей:

public IAmImmutable(string member1, string member2) 
{ 
    this._Member1 = member1; 
    this._Member2 = member2; 
} 

private readonly string _Member1; 
private readonly string _Member2; 

public string Member1 { get {return _Member1;} } 
public string Member2 { get {return _Member2;} } 

(признает ли это FxCop как «неизменный» класс это другой вопрос)

Обратите внимание, что это только работает, потому что string является неизменным. Если бы он был изменен на изменяемый тип (например, или Array), то ссылка была бы только для чтения, но содержимое могло быть изменено, что делает сам класс изменчивым.