SA1124 DoNotUseRegions предполагают, что регион не должен использоваться нигде. Это действительно разумно?
Я думаю, что регион - это способ сгруппировать относительный код вместе и сделать большой класс удобным для чтения, например, если вы создаете метод интерфейса для класса в vs2008 через контекстное меню, регион будет автоматически вставлен.
Я хотел бы удалить это правило, проверяя стиль кода. Могу ли я узнать ваше мнение по этому правилу?
Это будет личное предпочтение. Единственное, что имеет значение здесь, - это то, что вы и ваша команда предпочитаете. Забудьте, что говорит полицейский стиль, вы его читаете, вы его поддерживаете, независимо от того, работает ли с вами или без регионов, что все это имеет значение.
Если вы выпускаете его как проект с открытым исходным кодом... и это мое мнение здесь, я думаю, что то же самое. Используйте то, что более удобно для основной команды. Если вы получаете намного больше членов команды на борту и более вносите свой вклад, повторите посещение проблемы позже, это всегда можно изменить.
Больше нет необходимости в регионах в хорошо написанном коде. Когда-то было полезно спрятать сгенерированный компьютером код. Теперь этот код идет в отдельный файл. Регионы все еще могут использоваться для скрытия плохо написанного кода.
Я думаю, что регионы можно злоупотреблять, но они являются полезной техникой, позволяющей читателю сосредоточиться на определенных областях кода за раз.
Я бы избегал слишком много уровней гнездования.
Из моего опыта они не должны использоваться вообще. Младшие разработчики склонны злоупотреблять ими и создавать слишком сложные классы, сложность которых "умна" скрыта за многочисленными регионами.
По-моему, существует одно исключение, где имеет место область # region/# endregion: При реализации интерфейсов!
например.
#region Implementation of IDisposable
public void Dispose()
{
// implementation here ...
}
#endregion
Во всех остальных случаях вы не должны использовать #region, поскольку они устарели (я предполагаю, что созданный для скрытия сгенерированного кода -.net-1.0 и .net-1.1, но теперь для этого есть частичные классы)
- Харальд-Рене Флаш (он же hfrmobile)
Интересно, является ли это правило побочным эффектом других более общепринятых правил, таких как упорядочение частных/защищенных/публичных членов. Следуя этим правилам упорядочения, во многих случаях обязательно будет ломаться логическая группировка #областей, поэтому они станут взаимоисключающими.
Мне нравятся регионы и моя команда, и я чувствую, что код с ними более читабельен.
Вот когда я их люблю...
Если у вас есть стандарт компании для написания модульных тестов с помощью Assange Act Assert (AAA), тогда вам потребуются модульные тесты, чтобы выглядеть следующим образом
[test]
public void MyFunction_Test
{
#region Arrange
#endregion
#region Act
#endregion
#region Assert
#endregion
}
Мне очень нравится этот формат, особенно когда есть четкое разделение, и это вдохновляет других делать что-то правильно, например, правильно писать блок-тесты.
Другим местом, которое мне нравится в регионе, является код, когда вы знаете, что скоро собираетесь удалить код.
#region Drop this region next version when we drop 2003 support
public void DoSomeThingWithWindowsServer2003()
{
// code the is for Windows 2003 only
}
#endregion
Я также использую регионы для разделения разных частей моих классов, даже если класс очень мал.
#region Constructors
#endregion
#region Properties
#endregion
#region Events
#endregion
#region Methods
#endregion
#region Enums
#endregion
Обычно у класса не будет всех этих (если вам интересно, делаете ли вы слишком много в одном классе), но я думаю, что если вы ищете один метод или свойство, приятно иметь единственное место для просмотра. Не говоря уже о свойствах в ViewModel (MVVM anybody?), Использующем INotifyPropertyChanged, это 10 строк (9 строк плюс пробел), поэтому хорошо продуманный и хорошо написанный объект ViewModel с только 5 свойствами означает, что раздел свойств имеет не менее 50 строк кода.
Мне также особенно нравятся они при использовании кого-то плохо написанного кода. Глупо предположить, что вы всегда можете реорганизовать, чтобы использовать идеальный дизайн. Например, у вас есть класс с 2500 строк и более. Уверен, что это, вероятно, могло быть написано лучше, но вы этого не сделали, оно работает, и оно проверено, и ваш бизнес имеет код в "фиксированной" блокировке, поэтому рефакторинг не разрешен. Вы можете сделать слишком большой класс (плохо написанный или нет) гораздо более читаемым с помощью операторов #region. Вы получаете много преимуществ чтения от разделения проблем без фактического разделения класса, а затем, как только код выходит из строя, и вы можете реорганизовать, большая часть работы по разделению уже может быть выполнена с помощью #regions, и вы можете конвертировать ваши регионов в отдельный класс.