.NET coding guidelines и потенциальные баги

[metaclass]

.NET
По правилам написания кода класс с полем, инициализирующемся в конструкторе и свойством, которое дает доступ для чтения этого поля надо писать так:

public class SomeClass
{
private readonly string configMetaID;
public string ConfigMetaID{get{return configMetaID;}}

public SomeClass(string configMetaID)
{
this.configMetaID = configMetaID;
}
}

Достаточно вместо return configMetaID; написать return ConfigMetaID; и получим Stack overflow. А сделать это очень легко, так как используется автодополнение кода. Кроме того, можно забыть написать this. в конструкторе и поле останется не проинициализированным.
Правила кодирования заимствованны из Java, где свойств нету, а есть геттеры и сеттеры, префиксы get и set которых там не дадут устроить переполнение стека из-за ошибки.
Есть вариант обхода - сделать поле public, а свойство выкинуть. Оно все равно readonly, поэтому испортить снаружи его никто не сможет. Но это в чем-то противоречит правилам кодирования - поля делать public - плохой тон.

Comments

[vp.livejournal.com]

У меня давно критическое отношение к именованию класса с большой буквы, а экземпляра - тем же словом, только с маленькой буквой в начале.

Оно конечно теоретически очень красиво. Но источник багов еще тот. Особенно в условиях, когда все лабают с автодополнением кода.

[orloffm.livejournal.com]

VB.Net же вроде не различает регистр, разве в guidelines не указано, что нельзя делать переменные с отличающимися только регистром символов именами?

[metaclass.livejournal.com]

Это C#, он различает. По логике вещей идентификаторы различающиеся только регистром делать не стоило бы, но в данном случае получается противоречие - поле и свойство означают одно и тоже, соответственно делать сильно различающиеся имена нельзя.
В венгерской нотации это бы обходилось префиксом m_ для поля, но ее использовать в .NET не рекомендуется. Как и прочие вариации имен с подчеркиваниями в начале и тому подобное.

[axexa.livejournal.com]

признаюсь, за год интенсивного кодописания на сырфкз ни разу не впал в грех подобной описки.

[metaclass.livejournal.com]

А я вот сегодня впал :)
Это меня задрала путаница вариантов оформления кода в голове(венгерская нотация, дельфи и явовско-сишарпная) и я удосужился прочесть guidelines и пытаюсь им следовать.
До того было проще - я просто оформлял в венгерской нотации :)

[axexa.livejournal.com]

а-а-а, у нас только шарп проекты, поэтому легче. как вспомню приключения в плюсах с вечными пляшушими стилями -- обливаюсь потом.

венгерку, кстати, рекомендуют в этой книжке (есть в pdf) --
http://www.apress.com/book/bookDisplay.html?bID=10029
но болезненно усложненный шизовариант.

[axexa.livejournal.com]

в нашей группе мы следуем официальным гайдам, все привыкли и коллизий из-за этого нет (я не помню).

[mr-st.livejournal.com]

Я тоже пару раз нарывался. Посему приватные поля начинаются с подчёркивания.

[metaclass.livejournal.com]

Наверно наиболее правильно, хоть и запрещено в guidelines :)