Я только что запустил стиль cop против моего кода и получил несколько:
SA1600: The field must have a documentation header.
Теперь не поймите меня неправильно. Мне нравится стиль копа, это здорово, когда вы работаете над проектом с более чем одним человеком, но это правило кажется мне слишком чрезмерным. Почему вы хотите добавить:
/// <summary>
/// blah blah blah
/// </summary>
до вершины каждой переменной. Я уверен, что я помню, как кто-то сказал (Мартин Фаулер, Кент Бек... не помню ATM), что комментарий должен сказать "почему" не "что", и я действительно не могу понять, как вы можете объяснить, почему на переменная.
Я также нахожу код, который имеет комментарии к каждой переменной, более трудной для чтения, потому что все, что вы видите, - пух.
Мои мысли, если вам нужно объяснить, что каждая переменная, тогда вы действительно терпите неудачу с точки зрения именования.
Кто-нибудь еще находит комментирующие переменные немного запаха кода или это только я.