Чому Microsoft зробила параметри, локальні змінні та приватні поля однаковою умовою іменування?

Я задав це питання досить давно: Як ви називаєте свої приватні змінні в C #?

В одній з відповідей мене вказували на сторінку MSDN Microsoft, яка показує, що приватні змінні / поля повинні бути названі так:

private int myInteger;

Але параметром буде:

void SomeMethod(int myInteger)

і локальна змінна буде такою:

int myInteger;

Тож коли ви посилаєтесь на них так

myInteger = 10;

у вас немає способу знати, про кого ви говорите.

Зараз я починаю новий проект, і один з моїх колег запитує мене, чому ми не робимо щось для розмежування принаймні деяких з них.

Мені цікаво те саме. Чому стандарт Microsoft не зберіг цього?

У початкових конвенціях про іменування був префікс m_ для членів класу, який зводився до простого підкреслення. Ви побачите багато старих кодів C # Microsoft, використовуючи приставку підкреслення. Однак я чув у Tech Ed одного разу, що провідна підкреслення не відповідає CLS. Я припускаю, що це причина, чому вони перейшли до більш простої схеми "одне ім'я". Раніше (не впевнений зараз), що нечутливі назви VB.Net також не відповідають стандартам CLS.

Щодо того, що варто, я все ще використовую провідні підкреслення для учнів класу. Незважаючи на те, що ви можете роз'єднати цю функцію (це ім'я на відміну від імені), помилки все-таки проходять.

Вам не доведеться робити все, що вам каже MS.

localі parameterзмінні називаються однаково, тому що їх сфера застосування однакова

Щодо приватних змінних, то щодо цього існують різні думки. Я завжди використовував знайдені тут стандарти , в яких вказано використовувати передові _перед приватними змінними, хоча автор справді говорить, що _це трохи суперечливо і що Microsoft рекомендує проти цього.

У Вікіпедії зазначено, що в C і C ++

Імена, що починаються з подвійного підкреслення або підкреслення та великої літери, зарезервовані для реалізації (компілятор, стандартна бібліотека) і не повинні використовуватися (наприклад, __зарезервовано або _Зарезервовано).

тому, можливо, це було причиною того, що Microsoft рекомендувала проти цього, хоча досить добре відомо, що багато розробників Microsoft все одно використовують _префікс для своїх приватних змінних.

Я не можу вам точно сказати, чому вони не тримали їх іншими. Ймовірно, ніхто не може, якщо хтось, хто брав участь у створенні стандартів, не побачить цього питання.

Багато людей створюють свої власні угоди, випереджаючи змінні екземпляра з _або m_, але я дійсно не думаю , що це має значення. Ви можете зробити багато чого з контексту, і IDE в наші дні досить розумні, щоб допомогти вам. Наприклад, Visual Studio з додатком ReSharper покаже вам локальні та екземпляри змінних у різних кольорах.

Якщо вам дійсно важливо, що ви розмежовуєте між двома областями, ви можете використовувати this.префікс для позначення змінної екземпляра:

public class Test
{
    private int myInteger;

    void SomeMethod(int myInteger)
    {
        this.myInteger = 10; // sets instance variable to 10
        myInteger = 10; // does not affect the instance variable.
    }
}

Без будь-яких інших плагінів Visual Studio за замовчуванням допоможе вам з Intellisense:

(Спливаюче вікно все ще може бути стильоване ReSharper там, але ReSharper нічого не додає до функцій вбудованого Intellisense, тому, хоча запас може виглядати трохи інакше, він все одно матиме обидва варіанти. )

Ви також можете використовувати інструменти аналізу коду, такі як FxCop та StyleCop, щоб допомогти вам знайти потенційні проблеми із змінними іменами та областями.

Чому стандарт Microsoft не зберіг цього?

Люди в Microsoft написали книгу під назвою Framework Design Guidelines, в якій пояснили низку конвенцій, зокрема, чому деякі речі були викладені верблюдом , а інші - паскалом .

Редагування (додавання деталей із книги):

У книзі вони згадують про дослідження юзабіліті, а також деякі уроки, здобуті з придбання групи Turbo Pascal. Крім того, хоча не всі мови залежать від регістру (наприклад, VB), інші є (наприклад, C #), тому одна повинна бути послідовною у назві. Не можна залежати від різниць, якщо тільки окремі предмети розмежувати. Якщо один дотримуватись умов, які використовуються в решті рамок, це призведе до меншої плутанини з боку розробників.

Глава 3, Назви рекомендацій.
Розділ 3.1 - конвенції про капіталізацію.

camelCasingпризначений для імен параметрів.
PascalCasingпризначений для простору імен, типів та імен учасників. Якщо частина імені є двобуквенними абревіатурами, зберігайте їх з великої літери разом, наприклад IOStream.

Розділ 3.5 стосується іменування класів, структур та інтерфейсів.
Розділ 3.6 стосується іменування членів типу.
Розділ 3.7 охоплює параметри іменування.

Тому що вони досить помітні, оскільки залежать від контексту, в якому вони написані.

Наприклад, чи використовували ви коли-небудь параметр як змінну члена? Або локальна змінна як параметр? Як щодо змінної члена як локальної?

• Всі змінні учасника знаходяться в "тілі" класу. Я дійсно не купую аргумент про те, що вам потрібно встановити префікс члена, коли ви можете thisйого відрізнити від локальної змінної з подібною назвою, інакше він не потрібен.

• Локальна змінна також визначається лише в межах методу або в області блоку коду.

• Параметр завжди визначається в підписі методу.

Якщо ви переплутали або змішали всі ці типи змінних, то вам дійсно слід більше думати про свій дизайн коду, щоб зробити його більш читабельним або зрозумілим. Дайте їм кращі та більш описові назви, ніж myInteger.

Я не можу відповісти на ваше запитання щодо стандартів Microsoft. Якщо ви хочете стандартні розрізняти ці речі, стандартне використання I параметрів PL / SQL є префікс імені параметра з in_, out_, io_, для входів, амбулаторних, так і в-out- параметрів. Змінні, локальні для функції, мають префікс a v_.

Більшість компаній, яких я знаю, мають стандарти кодування, які визначають або підкреслення, або малу літеру m (для "члена" я припускаю) як префікс змінних своїх членів.

Так

_varName

або

mVarName

Подібно до того, як вказували інші люди, зазвичай ви можете сказати, за якою сферою застосування використовується предмет. Насправді ви не можете мати параметр і локальну змінну в тій самій області, і якщо ви хочете приватну змінну, просто використовуйте this.myInteger. Тому я не думаю, що Microsoft надто переживає з цього приводу, тому що ви можете легко розмежувати їх, якщо хочете.

Але, маючи на увазі, я трохи здивований, що ніхто ще цього не сказав, але забудьте про Microsoft та їхні умови домену імен (ну хтось, можливо, сказав це вже зараз, як мені довелося бігти на зустріч і залишив це відкритим, не подаючи заявку це). Угорська нотація також була конвенцією про іменування, розпочатою в Microsoft (чи це Xerox? Я ніколи не пам'ятаю, коли Симоній придумав це). Я не можу придумати когось, кого я знаю, що не проклинає назву угорської нотації донині. Ми стали настільки роздратовані цим на місці, що я працював, що ми придумали власний стандарт, який ми використовували внутрішньо. Для нас було більше сенсу і трохи пришвидшити нашу роботу (це було насправді досить близько до того, що пропонує Microsoft зараз, але все було паскальним випадком, за винятком приватних змінних).

Незважаючи на це, новіший стандарт, який використовує Microsoft (суміш футляра з верблюдом та паскаль), не надто поганий. Але якщо вам та вашим колегам це не подобається, придумайте власний набір стандартів (найкраще колективно). Звичайно, це залежить від того, чи має ваша компанія вже встановлений набір стандартів. Якщо вони роблять, дотримуйтесь їх. Інакше придумайте, що працює для вас та ваших колег. Просто тримайте це логічно.

Оскільки Aaronaught попросив посилання на Чарльза Симоні та угорську нотацію: http://en.wikipedia.org/wiki/Charles_Simini

http://en.wikipedia.org/wiki/Хунгарська_нотація

http://msdn.microsoft.com/en-us/library/aa260976(v=VS.60).aspx

http://ootips.org/hungarian-notation.html

http://www.hitmill.com/programming/vb/Hungarian.html

http://web.mst.edu/~cpp/common/hungarian.html

Останні два - лише приклади угорської нотації, а посилання ootips - це лише деякі цитати, що стосуються деяких думок з цього приводу. Зауважте, що існує також система Угорська нотація, але це також, наскільки я знаю, набуло популярності у програмістів Microsoft (хоча, на відміну від Simonyi для варіацій програм, я не знаю, у кого).