Pass ссылка типа по ссылке, чтобы указать, будет изменен

Question

Я нашел некоторый код в нашем приложении, который проходит через List<T> по ссылке, чтобы указать, что модифицируется:

void DoSomething(ref List<MyType> theList) 
{ 
    theList.Add(new MyType()); 
} 

Я думаю, ясно, что rEF- ключевое слово устарело в этом случае, так как мы могли бы также добавить новые элементы в список без ключевого слова. Однако это указывает на то, что мы модифицируем списки или, по крайней мере, его элементы. Я считаю, что это особенно полезно, если у вас много параметров и вы хотите увидеть, какие из них были изменены и которые просто переданы как значения для выполнения задания.

Вопрос, если это нормально, безусловно, основано на мнениях и будет недействительным для SO, я скорее спрошу, есть ли другой подход к достижению этого или если я даже должен заботиться об этом.

EDIT: Чтобы уточнить мой вопрос. Этот вопрос равен не, если список изменен, это был всего лишь пример. В качестве альтернативы я также использовал любой другой ссылочный тип, а не только List<T>.

Answer 1

Однако это означает, что мы меняем список.

Нет, это не так. Он указывает, что ссылка может быть изменена. С помощью ключевого слова ref как «идентификатор» что-то может измениться, по-моему, плохо, так как он открывает двери, которые вы, возможно, не захотите.

Я бы посоветовал изучить аспектно-ориентированное программирование, могли ли вы назначать атрибуты параметрам метода. Из нового компилятора Roslyn с его службами анализа кода вы можете даже проверить, не нарушает ли код основной данные.

Answer 2

Это намного проще и шире, чтобы читать интерфейс , чем смотреть референт и считать его меняющейся коллекцией.

Например, если вы хотите быть постоянным:

public DoSomething<T>(IReadOnlyCollection<T> collection) 
{ 
    //.... 
} 

непостоянным:

public DoSomething<T>(List<T> collection) 
{ 
    //.... 
} 

В случае типа значения это действительно, как вы уточнить ваш вопрос:

Постоянная ссылка:

public DoSomething(int value) 
{ 
    //.... 
} 

непостоянный:

public DoSomething(ref int value) 
{ 
    //.... 
} 

Или, если у вас есть тип без доступа к коду, например, поток:

public class StreamWrapper 
{ 
    private Stream _instance; 

    //now you can specify read or edit methods here and use this class in invokation. 
} 

Answer 3

Patrick приводит меня к альтернативному пути, который не полагается на атрибуты, поэтому мы можем использовать его в устаревшем коде на машинах со старым компилятором. Мы можем, конечно, написать API-документ appropritely, чтобы указать, что метод изменяет переданный параметр:

/// <summary/> 
/// <param name="theList">list to be modified</param> 
void DoSomething(List<MyType> theList) 

Я думаю, это лучше, так как он это не распространяется полагаться на whrong использование ключевого слова. Однако он предполагает, что клиенты нашего API внимательно прочитают документы.