6.1. Описание процедур и функций (методов класса)

Синтаксически в описании метода различают две части - описание заголовка и описание тела метода:

заголовок_метода
тело_метода

Рассмотрим синтаксис заголовка метода: [атрибуты][модификаторы]{void| тип_результата_функции}

имя_метода ([список_формальных_аргументов])

Имя метода и список формальных аргументов составляют сигнатуру метода. Отметим, что в сигнатуру не входят имена формальных аргументов - здесь важны типы аргументов. В сигнатуру не входит и тип возвращаемого результата.

Модификатор доступа может иметь четыре возможных значения, из которых пока рассмотрим только два - public и private. Модификатор public показывает, что метод открыт и доступен для вызова клиентами и потомками класса. Модификатор private говорит, что метод предназначен для внутреннего использования в классе и доступен для вызова только в теле методов самого класса. Отметим, что если модификатор доступа опущен, то по умолчанию предполагается, что он имеет значение private и метод является закрытым для клиентов и потомков класса.

Обязательным при описании заголовка является указание типа результата, имени метода и круглых скобок, наличие которых необходимо и в том случае, если сам список формальных аргументов отсутствует. Формально тип результата метода указывается всегда, но значение void однозначно определяет, что метод реализуется процедурой. Тип результата, отличный от void, указывает на функцию. Вот несколько простейших примеров описания методов:

void A() {...};
int B(){...};
public void C(){...};

Методы A и B являются закрытыми, а метод С - открыт. Методы A и С реализованы процедурами, а метод B - функцией, возвращающей целое значение.

Список формальных аргументов

Как уже отмечалось, список формальных аргументов метода может быть пустым, и это довольно типичная ситуация для методов класса. Список может содержать фиксированное число аргументов, разделяемых символом запятой.

Рассмотрим теперь синтаксис объявления формального аргумента:

[ ref | out | params ] тип_аргумента имя_аргумента.

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

Несмотря на фиксированное число формальных аргументов, есть возможность при вызове метода передавать ему произвольное число фактических аргументов. Для реализации этой возможности в списке формальных аргументов необходимо задать ключевое слово params. Оно задается один раз и указывается только для последнего аргумента списка, объявляемого как массив произвольного типа. При вызове метода этому формальному аргументу соответствует произвольное число фактических аргументов.

Содержательно, все аргументы метода разделяются на три группы: входные, выходные и обновляемые. Аргументы первой группы передают информацию методу, их значения в теле метода только читаются. Аргументы второй группы представляют собой результаты метода, они получают значения в ходе работы метода. Аргументы третьей группы выполняют обе функции. Их значения используются в ходе вычислений и обновляются в результате работы метода. Выходные аргументы всегда должны сопровождаться ключевым словом out, обновляемые - ref. Что же касается входных аргументов, то, как правило, они задаются без ключевого слова, хотя иногда их полезно объявлять с параметром ref. Отметим, если аргумент объявлен как выходной с ключевым словом out, то в теле метода обязательно должен присутствовать оператор присваивания, задающий значение этому аргументу. В противном случае возникает ошибка еще на этапе компиляции.

Для иллюстрации давайте рассмотрим группу методов класса Testing из проекта ProcAndFun:

/// <summary>
/// Группа перегруженных методов A()
/// первый аргумент представляет сумму кубов
/// произвольного числа оставшихся аргументов
/// Аргументы могут быть разного типа.
/// </summary>
private void A(out long p2, int p1) {
          p2 = (long) Math.Pow(p1, 3);
          Console.WriteLine("Метод A-1");
}
private void A(out long p2, params int[ ] p) {
p2 = 0;
for (int i = 0; i < p.Length; i++)
              p2 += (long) Math.Pow(p[i], 3);
Console.WriteLine("Метод A-2");
}
private void A(out double p2, double p1) {
          p2 = Math.Pow(p1, 3);
          Console.WriteLine( “Метод  A-3");
}
private void A(out double p2, params double[ ] p) {
p2 = 0;
for (int i = 0; i < p.Length; i++)
  p2 += Math.Pow(p[i], 3);
Console.WriteLine("Метод A-4");
}
/// <summary>
/// Функция с побочным эффектом
/// </summary>
/// <param name="a"> Увеличивается на 1</param>
/// <returns> значение a на входе</returns>
private int f(ref int a) {
          return a++;
}

Четыре перегруженных метода с именем A и метод f будут использоваться при объяснении перегрузки и побочного эффекта. Сейчас проанализируем только их заголовки. Все методы закрыты, поскольку объявлены без модификатора доступа. Перегруженные методы с именем A являются процедурами, метод f - функцией. Все четыре перегруженных метода имеют разную сигнатуру. Хотя имена и число аргументов у всех методов одинаковы, но типы и ключевые слова, предшествующие аргументам, различны. Первый аргумент у всех четырех перегруженных методов - выходной и сопровождается ключевым словом out, в теле метода этому аргументу присваивается значение. Аргумент функции f - обновляемый, он снабжен ключевым словом ref, в теле функции используется его значение для получения результата функции, но и само значение аргумента изменяется в теле функции. Два метода из группы перегруженных методов используют ключевое слово params для своего последнего аргумента. Позже мы увидим, что при вызове этих методов указанному аргументу будет соответствовать несколько фактических аргументов, число которых может быть произвольным.

Тело метода

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

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

Знания семантики описаний и операторов достаточно для понимания семантики блока.