Можно ли назвать эту строку «String» опасной или плохой практикой?

Question

У меня есть класс под названием SerializableString, который расширяет базовый класс CustomXmlSerializable. Базовый класс предоставляет методы для сериализации и десериализации производного класса XML.

public class SerializableString : CustomXmlSerializable 
{ 
    public string String { get; set; } 
} 

Очевидно, что я могу назвать string свойством, что я хочу. Но поскольку этот класс является настолько общим по своей природе, было бы неплохо дать ему очень очевидное имя, например «String». Таким образом, объект доступен как:

SerializableString userName = new SerializableString(); 
userName.String = "khargoosh"; 

Этот компилятор допускает это. Невзирая на характер класса и собственности, было бы ли это плохой практикой или опасным, чтобы дать одно и только свойство в классе имени «String»?

Answer 1

Не делайте этого , хотя он действителен в отношении компилятора. Пример Эрика Липперта Color Color отличается - большинство вещей редко имеют более одного свойства цвета, поэтому присвоение имени Color обычно сообщает вам все, что вам нужно знать об этом свойстве. Я называю это действительным случаем, когда использование имени типа (Color) подходит для использования в качестве имени свойства. (Можно было бы утверждать, является ли это хорошим аргументом, но в прошлом мне приходилось иметь дело с этой точной проблемой и в конечном итоге использовало Color Color.)

В случае string String вы ничего не узнали от названия объекта - данный объект может иметь (и объекты часто) несколько свойств типа string. Именование свойства String ничего не говорит о цели этого свойства. Это затрудняет понимание кода.

Это всего лишь личное мнение - как указывает другой ответ, это синтаксически справедливо. В конце концов, это решение - я бы избегал наименования свойства после его типа как можно больше. Более длинные уникальные имена свойств/функций обычно содержат больше информации о предполагаемом использовании этого символа.

Специально для этого вопроса, я бы назвал свойство Value:

public string Value { get; set; } 

Answer 2

Как говорит сам Эрик Липперт here, это «совершенно приемлемая практика, язык C# был тщательно разработан, чтобы это было законным и практичным».

Кроме того, в этом случае кажется однозначным то, что означает ваше свойство String: у вас есть класс, который похож на строку, но сериализуется, и это свойство возвращает основную строку. Предположим, что String не был примитивным типом, а примитивный тип был str или что-то в этом роде. Тогда мне не кажется, что возникнет какая-либо проблема или двусмысленность при вызове этого свойства (центральное свойство вашего класса) просто «String» (с возвратом типа str в моем гипотетическом случае)