方法 (C# 编程指南)

方法是包含一系列语句的代码块。 程序通过调用该方法并指定任何所需的方法参数使语句得以执行。 在 C# 中,每个执行的指令均在方法的上下文中执行。

该方法 Main 是每个 C# 应用程序的入口点,在启动程序时由公共语言运行时 (CLR) 调用。 在使用 顶级语句的应用程序中, Main 该方法由编译器生成,并包含所有顶级语句。

注释

本文讨论命名方法。 有关匿名函数的信息,请参阅 Lambda 表达式

方法签名

方法在结构接口中声明,通过指定访问级别(如publicprivate)以及可选修饰符(如abstractsealed),并定义返回值、方法名称和任何方法参数。 这些部分共同构成了该方法的签名。

重要

出于方法重载的目的,方法的返回类型不是方法签名的一部分。 但是在确定委托和它所指向的方法之间的兼容性时,它是方法签名的一部分。

方法参数在括号内,并且用逗号分隔。 空括号指示方法不需要任何参数。 此类包含四种方法:

abstract class Motorcycle
{
    // Anyone can call this.
    public void StartEngine() {/* Method statements here */ }

    // Only derived classes can call this.
    protected void AddGas(int gallons) { /* Method statements here */ }

    // Derived classes can override the base class implementation.
    public virtual int Drive(int miles, int speed) { /* Method statements here */ return 1; }

    // Derived classes must implement this.
    public abstract double GetTopSpeed();
}

方法访问

对对象调用方法就像访问字段一样。 在对象名称之后,添加句点、方法的名称和括号。 参数列在括号内,用逗号分隔。 因此,可以调用类的方法 Motorcycle ,如以下示例所示:

class TestMotorcycle : Motorcycle
{
    public override double GetTopSpeed()
    {
        return 108.4;
    }

    static void Main()
    {
        TestMotorcycle moto = new TestMotorcycle();

        moto.StartEngine();
        moto.AddGas(15);
        moto.Drive(5, 20);
        double speed = moto.GetTopSpeed();
        Console.WriteLine($"My top speed is {speed}");
    }
}

方法形参与实参

该方法定义指定任何所需参数的名称和类型。 当代码调用该方法时,它为每个参数提供具体值,称为参数。 参数必须与参数类型兼容,但调用代码中使用的参数名称(如果有)不必与方法中定义的参数相同。 例如:

public void Caller()
{
    int numA = 4;
    // Call with an int variable.
    int productA = Square(numA);

    int numB = 32;
    // Call with another int variable.
    int productB = Square(numB);

    // Call with an integer literal.
    int productC = Square(12);

    // Call with an expression that evaluates to int.
    productC = Square(productA * 3);
}

int Square(int i)
{
    // Store input argument in a local variable.
    int input = i;
    return input * input;
}

按引用传递与按值传递

默认情况下,将 值类型的 实例传递给方法时,将传递其副本,而不是实例本身。 因此,对参数的更改对调用方法中的原始实例没有影响。 若要按引用传递值类型实例,请使用 ref 关键字。 有关详细信息,请参阅 传递 Value-Type 参数

将引用类型的对象传递给方法时,将传递对对象的引用。 也就是说,该方法接收的不是对象本身,而是一个指示对象位置的参数。 如果使用此引用更改对象的成员,则更改将反映在调用方法中的参数中,即使按值传递对象也是如此。

使用 class 关键字创建引用类型,如以下示例所示:

public class SampleRefType
{
    public int value;
}

现在,如果将基于此类型的对象传递给方法,则会传递对对象的引用。 以下示例将类型为 SampleRefType 的对象传递给方法 ModifyObject

public static void TestRefType()
{
    SampleRefType rt = new SampleRefType();
    rt.value = 44;
    ModifyObject(rt);
    Console.WriteLine(rt.value);
}

static void ModifyObject(SampleRefType obj)
{
    obj.value = 33;
}

该示例实质上与上一个示例相同,因为它按值将参数传递给方法。 但是,由于使用了引用类型,因此结果不同。 ModifyObject 中所做的对形参 valueobj字段的修改,也会更改 value 方法中实参 rtTestRefType 字段。 该方法 TestRefType 将 33 显示为输出。

有关如何按引用和按值传递引用类型的详细信息,请参阅 传递 Reference-Type 参数引用类型

返回值

方法可以将值返回到调用方。 如果返回类型(方法名称之前列出的类型不是void),则该方法可以使用语句返回值return。 一个 return 关键字后跟一个与返回类型匹配的值的语句会将该值返回到方法调用方。

该值可以按值或引用返回给调用者。 如果在 ref 方法签名中使用关键字,并且它遵循每个 return 关键字,则通过引用将值返回给调用方。 例如,以下方法签名和 return 语句指示该方法返回由调用方引用命名 estDistance 的变量。

public ref double GetEstimatedDistance()
{
    return ref estDistance;
}

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 result = obj.AddTwoNumbers(1, 2);
result = obj.SquareANumber(result);
// The result is 9.
Console.WriteLine(result);
result = obj.SquareANumber(obj.AddTwoNumbers(1, 2));
// The result is 9.
Console.WriteLine(result);

在这种情况下, result使用局部变量存储值是可选的。 它可能有助于代码的可读性,或者如果需要为方法的整个范围存储参数的原始值,则可能需要用到它。

若要使用从方法引用返回的值,如果要修改其值,则必须声明 ref 局部 变量。 例如,如果 Planet.GetEstimatedDistance 方法按引用返回值 Double ,则可以使用如下所示的代码将其定义为 ref 局部变量:

ref double distance = ref Planet.GetEstimatedDistance();

如果调用函数将数组传递到 M,则无需从修改数组内容的方法 M 返回多维数组。 可以返回由 M 生成的数组以提高代码风格或功能流畅性,但这并不是必须的,因为 C# 对所有引用类型进行按值传递,而数组引用的值实际上是指向数组的指针。 在方法 M中,任何对数组内容的更改都可由任何对数组具有引用的代码观察到,如以下示例所示:

static void Main(string[] args)
{
    int[,] matrix = new int[2, 2];
    FillMatrix(matrix);
    // matrix is now full of -1
}

public static void FillMatrix(int[,] matrix)
{
    for (int i = 0; i < matrix.GetLength(0); i++)
    {
        for (int j = 0; j < matrix.GetLength(1); j++)
        {
            matrix[i, j] = -1;
        }
    }
}

异步方法

通过使用异步功能,你可以调用异步方法而无需使用显式回调,也不需要跨多个方法或 lambda 表达式来手动拆分代码。

如果用 async 修饰符标记方法,则可以在该方法中使用 await 运算符。 当控件到达异步方法中的 await 表达式时,控件将返回到调用方,并在等待任务完成前,方法中进度将一直处于挂起状态。 任务完成后,可以在方法中恢复执行。

注释

异步方法在遇到第一个尚未完成的 awaited 对象或到达异步方法的末尾时(以先发生者为准),将返回到调用方。

异步方法通常具有返回类型Task<TResult>TaskIAsyncEnumerable<T>voidvoid 返回类型主要用于定义需要 void 返回类型的事件处理程序。 无法等待返回 void 的异步方法,并且返回 void 方法的调用方无法捕获该方法引发的异常。 异步方法可以具有任何类似任务的返回类型

在下面的示例中, DelayAsync 是一个返回类型的 Task<TResult>异步方法。 DelayAsync 具有返回 return 整数的语句。 因此,方法声明 DelayAsync 的返回类型 Task<int>必须为 . 由于返回类型是Task<int>,因此在await中对DoSomethingAsync表达式的计算将生成一个整数,如以下语句所示:int result = await delayTask

该方法 Main 是异步方法的一个示例,该方法的返回类型为 Task. 它转到 DoSomethingAsync 该方法,因为它用单行表示,因此可以省略 asyncawait 关键字。 由于DoSomethingAsync是异步方法,因此必须等待调用DoSomethingAsync的任务,如以下语句所示: await DoSomethingAsync();

class Program
{
    static Task Main() => DoSomethingAsync();

    static async Task DoSomethingAsync()
    {
        Task<int> delayTask = DelayAsync();
        int result = await delayTask;

        // The previous two statements may be combined into
        // the following statement.
        //int result = await DelayAsync();

        Console.WriteLine($"Result: {result}");
    }

    static async Task<int> DelayAsync()
    {
        await Task.Delay(100);
        return 5;
    }
}
// Example output:
//   Result: 5

异步方法不能声明任何 refout 参数,但它可以调用具有此类参数的方法。

有关异步方法的详细信息,请参阅使用 Async 和 Await 的异步编程异步返回类型

表达式主体定义

具有立即仅返回表达式结果,或单个语句作为方法主题的方法定义很常见。 可以使用以下语法快捷方式定义此类方法 =>

public Point Move(int dx, int dy) => new Point(x + dx, y + dy);
public void Print() => Console.WriteLine(First + " " + Last);
// Works with operators, properties, and indexers too.
public static Complex operator +(Complex a, Complex b) => a.Add(b);
public string Name => First + " " + Last;
public Customer this[long id] => store.LookupCustomer(id);

如果方法返回 void 或是异步方法,则方法的主体必须是语句表达式(与 lambda 相同)。 对于属性和索引器,两者必须是只读的,并且不使用 get 访问器关键字。

迭代器

迭代器对集合执行自定义迭代,如列表或数组。 迭代器使用 yield return 语句返回元素,每次返回一个。 到达 yield return 语句时,会记住当前在代码中的位置。 下次调用迭代器时,将从该位置重启执行。

使用 foreach 语句从客户端代码调用迭代器。

迭代器的返回类型可以是 IEnumerableIEnumerable<T>IAsyncEnumerable<T>IEnumeratorIEnumerator<T>

有关更多信息,请参见 迭代器

C# 语言规范

有关详细信息,请参阅 C# 语言规范。 语言规范是 C# 语法和用法的明确来源。

另请参阅