4. Локальные переменные

   1. Объявляйте переменные непосредственно перед их использованием.

   2. Счетчики в циклах традиционно называют i, j, k, l, m, n.

   3. Для временных локальных переменных, используемых в коротких участках кода, можно давать имена, состоящие из начальных букв слов имени типа.

   4. Не объявляйте более одной переменной в одной инструкции.

   5. Имена скрытых (protected, protected internal и private) переменных-членов класса и статических переменных начинайте с одиночного символа подчеркивания.

   6. Имена публичных (internal и public) переменных должны быть в стиле Паскаль и не иметь подчеркивания в качестве префикса.

   7. Комментируйте объявления так, чтобы были понятны назначение и способы использования переменной.

   8. Инициализируйте переменные при объявлении, если это возможно.

Пример:

class Class1 { private int _totalLineCount = 0; void SomeFunction(int startValue) { int lineCount = startValue; using (StreamReader sr = File.OpenText(@"c:\MyFile.txt")) { while (sr.ReadLine() != null) lineCount++; } _totalLineCount = lineCount; } }

5. Комментарии

   1. Не используйте многострочные (/*...*/) комментарии для описания классов и методов, используйте для этих целей XML documentation-комментарии. Многострочные комментарии не могут быть вложенными, поэтому их использование может создать проблемы.

   2. Для описания сути некоторого участка кода, пояснений к алгоритму и другой важной информации используйте несколько подряд идущих однострочных комментариев (//...). Между группой комментариев и собственно кодом поставьте пустую строку. Это покажет, что комментарий относится к блоку кода, а не к конкретной инструкции. Напротив, если комментарий относится к конкретной инструкции, прижмите его вплотную к этой инструкции.

   3. Комментируйте объявления переменных, по возможности используя XML-комментарии. Если язык не поддерживает XML-комментариев, можно использовать однострочные комментарии на той же строке, как это показано ниже.

   4. Отделяйте текст комментария одним пробелом «// Текст комментария.».

   5. Комментируя код, старайтесь объяснять, что он делает, а не какая операция производится. Так, инструкции if соответствует выражение «если... то...», причем часть, идущая за «то», является кодом, который будет выполняться, если выражение в if будет верным. Таким образом, для конструкции «if (somePath && File.Exists(somePath))», нужно написать комментарий «// Если выбранный файл существует, то...», а не «// Производим проверку на наличие файла и, если он имеется, удаляем его». Часть предложения, идущую за «то», вписывайте непосредственно перед выполнением конкретных действий. Для инструкций, осуществляющих действия, пишите «// Производим...» или «// Делаем...», где вместо троеточия вписывайте описания действий. Описывая действия, старайтесь описывать суть происходящего, а не то, что делают те или иные операторы. Так, совершенно бессмысленны комментарии вроде «Присваиваем переменной a значение b» или «вызываем метод f».

   6. Помните, что экономить на комментариях нельзя. Однако не стоит также формально подходить к процессу создания комментариев. Задача комментария – упростить понимание кода. Есть немало случаев, когда сам код отличным образом себя документирует.

Примеры:

/// <summary>indentation level</summary> int level; int size; // size of table // Line 1 // ArrayList list = new ArrayList(10); // Line 1 // Line 2 // for (int i = 0; i < list.Count; i++) ...