6. Возвращаемые значения
Методы могут возвращать значения вызывающим их объектам. Если тип возвращаемого значения, указываемый перед именем метода, и не равен void, для возвращения значения используется ключевое слово return. В результате выполнения инструкции с ключевым словом return, после которого указано значение нужного типа, вызвавшему метод объекту будет возвращено это значение. Кроме того, ключевое слово return останавливает выполнение метода. Если тип возвращаемого значения void, инструкцию return без значения все равно можно использовать для завершения выполнения метода. Если ключевое слово return отсутствует, выполнение метода завершится, когда будет достигнут конец его блока кода. Для возврата значений методами с типом возвращаемого значения отличным от void необходимо обязательно использовать ключевое слово return. Например, в следующих двух методах ключевое слово return служит для возврата целочисленных значений:
class SimpleMath
{
public int AddTwoNumbers(int number1, int number2)
{
return number1 + number2;
}
public int SquareANumber(int number)
{
return number * number;
}
}
Чтобы использовать возвращаемое методом значение в вызываемом методе, вызов метода можно поместить в любое место кода, где требуется значение соответствующего типа. Кроме того, возвращаемое значение можно присвоить переменной. Например, следующие два примера кода выполняют одну и ту же задачу:
int result1 = obj.AddTwoNumbers(1, 2);
result1 = obj.SquareANumber(result);
// Результат: 9
Console.WriteLine(result1);
int result1 = 0;
result2 = obj.SquareANumber(obj.AddTwoNumbers(1, 2));
Console.WriteLine(result2);
Использовать локальную переменную для хранения значения (в данном случае это переменные result1 и result2) необязательно. Эта переменная может упростить читаемость кода либо быть необходимой, если необходимо сохранить исходное значение аргумента для целой области метода.
3.7.2. Метод: именованные и необязательные аргументы Метод: именованные и необязательные аргументы
В Visual C# 2010 появились именованные и необязательные аргументы. Именованные аргументы позволяют указать аргумент для определенного параметра, связав аргумент с именем параметра, а не с позицией параметра в списке параметров. Необязательные аргументы позволяют опускать аргументы для некоторых параметров. Оба подхода можно применять к методам, индексаторам, конструкторам и делегатам.
При использовании именованных и необязательных аргументов аргументы вычисляются в том порядке, в котором они указаны в списке аргументов, а не в списке параметров.
При совместном использовании именованных и необязательных параметров разработчик может задавать аргументы лишь для некоторых параметров из списка необязательных параметров. Эта возможность значительно упрощает вызов интерфейсов COM, например интерфейсов API автоматизации Microsoft Office.
Именованные аргументы освобождают разработчика от необходимости помнить или уточнять порядок следования параметров при вызове методов. Параметр для каждого из аргументов можно задать с помощью имени параметра. Например, функцию, которая вычисляет индекс массы тела, можно вызвать обычным способом, путем передачи аргументов для веса и роста по их позиции в том порядке, в котором они заданы в определении функции:
CalculateBMI(123, 64);
Если разработчик не помнит порядок параметров, но знает их имена, он может передать аргументы в любом порядке, сначала указав вес или рост:
CalculateBMI(weight: 123, height: 64);
CalculateBMI(height: 64, weight: 123);
Кроме того, именованные аргументы упрощают восприятие кода, поскольку они указывают назначение того или иного аргумента.
Именованный аргумент можно поместить после позиционных аргументов, как показано ниже:
CalculateBMI(123, height: 64);
Однако позиционные аргументы нельзя размещать после именованных аргументов. Следующая инструкция вызывает ошибку компилятора:
CalculateBMI(weight: 123, 64);
Код реализации примеров выше:
class NamedExample
{
static void Main(string[] args)
{
// Метод с нормальным вызовом (позиции аргументов на месте)
Console.WriteLine(CalculateBMI(123, 64));
// Именованные аргументы с именами
Console.WriteLine(CalculateBMI(weight: 123, height: 64));
Console.WriteLine(CalculateBMI(height: 64, weight: 123));
// Позиционные аргументы после именованных
//Console.WriteLine(CalculateBMI(weight: 123, 64));
// Именованные аргументы после позиционных
Console.WriteLine(CalculateBMI(123, height: 64));
}
static int CalculateBMI(int weight, int height)
{
return (weight * 703) / (height * height);
}
}
В определении метода, конструктора, индексатора или делегата можно указать, что параметры являются обязательными или необязательными. При каждом вызове необходимо указывать аргументы для всех обязательных параметров, но можно опустить аргументы для необязательных параметров.
В рамках определения каждого необязательного параметра задается его значение по умолчанию. Если для параметра не передается аргумент, используется значение по умолчанию. Значения по умолчанию должны быть константами.
Необязательные параметры определяются в конце списка параметров после всех обязательных параметров. Если вызывающий объект задает аргумент для какого-либо из последующих необязательных параметров, он должен задать аргументы для всех предшествующих необязательных параметров. Разделённые запятыми пустые позиции в списке аргументов не поддерживаются. Например, в следующем коде метод экземпляра ExampleMethod определён одним или двумя необязательными параметрами:
public void ExampleMethod(int required,
string optionalstr = "Строка по умолчанию", int optionalint = 10)
Следующий вызов ExampleMethod вызывает ошибку компилятора, поскольку аргумент предоставлен для третьего параметра, а не для второго:
anExample.ExampleMethod(3, ,4);
Но если имя третьего параметра известно, задачу можно выполнить с использованием именованного аргумента:
anExample.ExampleMethod(3, optionalint: 4);
IntelliSense использует квадратные скобки для указания необязательных параметров:
Рис. 1. Подсветка IntelliSense при вызове метода ExampleMethod (A ― специальный пустой класс с методом)
В следующем примере у конструктора класса ExampleClass имеется один параметр, который является необязательным. У метода экземпляра ExampleMethod имеется один обязательный параметр required и два необязательных параметра optionalstr и optionalint. В коде в методе Main показаны различные способы вызова конструктора и метода:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace LC_Console
{
namespace OptionalNamespace
{
class OptionalExample
{
static void Main()
{
ExampleClass anExample = new ExampleClass();
anExample.ExampleMethod(1, "Один", 1);
anExample.ExampleMethod(2, "Два");
anExample.ExampleMethod(3);
// Пример anotherExample отправляет аргумент опционального параметра в конструктор
ExampleClass anotherExample = new ExampleClass("Имя");
anotherExample.ExampleMethod(1, "Один", 1);
anotherExample.ExampleMethod(2, "Два");
anotherExample.ExampleMethod(3);
// Код ниже вызовет ошибки
// Аргумент должен быть предоставлен для первого параметра, и это
// должно быть целое число
//anExample.ExampleMethod("Один", 1);
//anExample.ExampleMethod();
// Нельзя оставить зазор в предоставляемых аргументах
//anExample.ExampleMethod(3, ,4);
//anExample.ExampleMethod(3, 4);
// А с импользованием имён аргументов код заработает
anExample.ExampleMethod(3, optionalint: 4);
Console.WriteLine("Для продолжения нажмите любую клавишу . . ."); ;
Console.ReadKey();
}
}
class ExampleClass
{
private string _name;
// Because the parameter for the constructor, name, has a default
// value assigned to it, it is optional.
public ExampleClass(string name = "Имя по умолчанию")
{
_name = name;
}
// The first parameter, required, has no default value assigned
// to it. Therefore, it is not optional. Both optionalstr and
// optionalint have default values assigned to them. They are optional.
public void ExampleMethod(int required, string optionalstr = "Строка по умолчанию",
int optionalint = 10)
{
Console.WriteLine("{0}: {1}, {2}, и {3}", _name, required, optionalstr,
optionalint);
}
}
}
}
/* Выведет:
* Имя по умолчанию: 1, Один, и 1.
* Имя по умолчанию: 2, Два, и 10.
* Имя по умолчанию: 3, Строка по умолчанию, и 10.
* Имя: 1, Один, и 1.
* Имя: 2, Два, и 10.
* Имя: 3, Строка по умолчанию, и 10.
* Имя по умолчанию: 3, Строка по умолчанию, и 4.
*/
Именованные и необязательные аргументы, а также поддержка динамических объектов и другие усовершенствования значительно улучшаю взаимодействие с интерфейсами API COM, например с API автоматизации Office.
Например, у метода AutoFormat в интерфейсе Microsoft Office Excel ― Range имеется семь параметров, все из которых необязательны.
Использование именованных и необязательных аргументов следующим образом влияет на разрешение перегрузки:
метод, индексатор или конструктор является кандидатом на выполнение, если каждый из его параметров является необязательным или соответствует по имени или позиции одному аргументу в инструкции вызова, а этот аргумент можно преобразовать к типу параметра;
если обнаружено более одного кандидата, правила разрешения перегрузки для предпочтительных преобразований применяются к аргументам, которые заданы в явном виде. Опущенные аргументы для необязательных параметров игнорируются;
если два кандидата оказываются одинаково подходящими, предпочтение отдаётся кандидату, у которого нет необязательных параметров, аргументы которых были опущены в вызове. Это последовательность общего приоритета при разрешении перегрузки для кандидатов с меньшим числом параметров.