Блог о программировании: правила кодировок. Оптимизация программного кода.


23 Янв

Правила именования пременных в C#

Большинство начинающих программистов, не задумываясь, «лепят» в своих первых программах чуть ли не весь латинский алфавит для переменных во всех программах. Естественно, если программа написана наспех и не откоментированна как следует, то открыв ее через пол года, вы и не вспомните какие переменные и что означают.

Есть несколько общепринятых правил правильного объявления переменных:

Pascal case convention (нотация Паскаля)

  • каждое отдельное слово в идентификаторе начинается с буквы в верхнем регистре;
  • разделители между словами не используются;
  • начинаться идентификатор должен с большой буквы;
  • в идентификаторе используются только буквы латинского алфавита.
1
2
3
double Price;
double Count;
double CurrentPrice = Price*Count;

Camel case convention: аналогичен Pascal case convention, единственное его отличие в том, что идентификаторы начинаются с буквы в нижнем регистре.

1
2
3
double price;
double pount;
double currentPrice = price*count;

Uppercase convertion:  все символы идентификатора должны начинаться с букв в верхнем регистре. Встречается редко, за исключением случаев, когда идентификатор соответствует некоторым аббревиатуре или акрониму.

Вот главные правила на которые стоит ориентироваться при описании идентификаторов программы.

  1. локальные переменные класса начинаются с символа нижнего подчеркивания «_» и далее с буквы в нижнем регистре;
  2. общедоступные переменные начинаются с буквы в нижнем регистре;
  3. классы, функции, методы и свойства начинаются с большой буквы;
  4. каждое следующее слов в идентификаторе начинается с буквы в верхнем регистре без разделителя;
  5. именование интерфейсов начинается с «I» (что указывает, что это интерфейс) и далее с буквы в верхнем регистре каждое слова без разделителей.

И, наконец, самое главное именуйте переменные так, чтобы было понятно, какие данные хранятся в этой переменной.

Пример правильного объявления переменных:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
   // некоторый интерфейс
   //
    interface IMyInterface
    {
        void Show();
    }
    ///
    /// некоторый класс, который наследуется от интерфейса
    ///
    class MyClass:IMyInterface
    {
        private int _privatVariable; //объявление приватной переменной
        public char publicVariable = '$'; //объявление общедоступной переменной
        public int PropertiesPrivateVariable //свойства для приватной переменной _privatVariable
        {
            get
            {
                return _privatVariable;
            }
            set
            {
                _privatVariable = value;
            }
        }
        public MyClass()
        {
        }
 
        #region IMyInterface Members
 
        public void Show()
        {
            Console.WriteLine("Это метод Show() из класса MyClass");
        }
 
        #endregion

Именуйте переменные правильно и вашу программу с легкостью сможет «прочитать» и доработать программист, который будет работать после вас.



Написать ответ

Если не не хватает собственных идей и чешутся руки перепечатать, так оставьте ссылочку на источник
© 2012 Programmistka.com.ua