方法 (C# 程式設計手冊)

發行項
03/01/2013

「方法」(Method) 是包含一系列陳述式 (Statement) 的程式碼區塊。程式會「呼叫」(Calling) 方法並指定所有必要的方法引數，藉以執行陳述式。在 C# 中，每個執行的指令都會在方法的內容中執行。Main 方法是所有 C# 應用程式的進入點，當程式啟動時，是由 Common Language Runtime (CLR) 所呼叫。

注意事項
本主題將會討論具名方法。如需匿名函式的詳細資訊，請參閱匿名函式 (C# 程式設計手冊)。

方法簽章

藉由指定 public 或 private 之類的存取層級、abstract 或 sealed 之類的選擇性修飾詞 (Modifier)、傳回值、方法名稱，以及任一方法參數，便可在類別或建構中宣告方法。這些部分會共同組成該方法的「簽章」(Signature)。

注意事項
方法的傳回型別，並不是可做為方法多載之用的方法簽章部分。然而，當判斷委派 (Delegate) 以及其所指向之方法之間的相容性時，它就是方法簽章的一部分。

方法參數會以括號括住且以逗號隔開。空白的括號表示該方法不需要參數。此類別包含三種方法：

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 {0}", speed);            
    }
}

方法參數的. 引數。

方法定義會指定任何必要「參數」(Parameter) 的名稱和型別。當進行呼叫的程式碼呼叫方法時，會提供每個參數的具體值，此稱為「引數」(Argument)。引數必須與參數型別相容，但呼叫程式碼中使用的引數名稱 (如果有的話) 不必與方法中定義的參數名稱相同。例如：

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 evaulates to int.
    productC = Square(productA * 3);
}

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

以傳址方式. 傳遞值

根據預設，當實值型別傳遞至方法時，所傳遞的是複本而非物件本身。所以對引數所做的變更在呼叫的方法內不會對原始複本造成任何影響。您可以使用 ref 關鍵字，以傳址 (By Reference) 方式傳遞實值型別。如需詳細資訊，請參閱傳遞實值型別的參數 (C# 程式設計手冊)。如需內建實值型別的清單，請參閱實值型別表 (C# 參考)。

當參考型別的物件傳遞至方法時，物件的參考傳遞。即方法接收不是物件，而且會指示物件的位置引數。使用這個參考，如果您變更物件的成員，這項變更會反映在引數上呼叫的方法，，即使您透過物件值。

如下列範例所示，使用 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;
}

這個範例基本上的作用與上一個範例相同因為傳遞引數值傳遞給方法。但是，，，因為使用參考型別，結果是不同的。在對參數的 value 欄位的 ModifyObject 進行的修改， obj，也將引數， rt的 value 欄位，在 TestRefType 方法。TestRefType 方法顯示超過做為輸出。

如需如何透過參考型別的詳細資訊參考和值，請參閱傳遞參考型別的參數 (C# 程式設計手冊) 和參考型別 (C# 參考)。

傳回值

方法可將值傳回呼叫端。如果傳回型別 (也就是列在方法名稱前面的型別) 不是 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 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，存放值是選擇性的。不過，這個變數會讓程式碼更具可讀性，而且如果您要在整個程式碼範圍中儲存引數的原始值，就有必要使用這個變數。

如需詳細資訊，請參閱return (C# 參考)。

非同步方法

經由非同步功能，您可以叫用非同步方法，而不需要使用明確的回呼或手動分割您的多個方法或 Lambda 運算式的程式碼。非同步功能就是引入的 Visual Studio 2012。

如果您將標記為已與非同步修飾詞的方法，您可以使用方法在等候運算子。當控制項到達非同步方法的一個等候，表示控制項傳回至呼叫端，因此，在方法的進度暫止，直到等候的工作完成。當工作完成時，則會從方法可以復原。

注意事項
非同步方法傳回至呼叫端時，可能會遇到無法完成時或它有非同步方法的結尾先等候的物件，視何者先發生。

非同步方法可能有 Task<TResult>、 Task或 void 傳回型別。void 傳回型別主要用於定義事件處理常式，需要 void 傳回型別。空的傳回無法等候的非同步方法和方法所傳回的方法的呼叫端無法攔截方法擲回的例外狀況。

在下列範例中， DelayAsync 是有 Task<TResult>之傳回型別的非同步方法。DelayAsync 有傳回整數的 return 陳述式。因此 DelayAsync 的方法宣告必須有 Task<int>的傳回型別。因為傳回型別是 Task<int>， await 運算式的評估 DoSomethingAsync 來產生整數時，下列陳述式所示: int result = await delayTask。

startButton_Click 方法是有 void 傳回型別非同步方法的範例。由於 DoSomethingAsync 為非同步方法，必須等候呼叫的效能資料，對 DoSomethingAsync ，如下列陳述式所示: await DoSomethingAsync();。因為方法有一個 await 表示，必須定義 startButton_Click 方法與 async 修飾詞。

// using System.Diagnostics;
// using System.Threading.Tasks;

// This Click event is marked with the async modifier.
private async void startButton_Click(object sender, RoutedEventArgs e)
{
    await DoSomethingAsync();
}

private 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();

    Debug.WriteLine("Result: " + result);
}

private async Task<int> DelayAsync()
{
    await Task.Delay(100);
    return 5;
}

// Output:
//  Result: 5

非同步方法不可以宣告任何參考或參數，不過，它可以呼叫具有這類參數的方法。

如需非同步方法的詳細資訊，請參閱使用 Async 和 Await 設計非同步程式 (C# 和 Visual Basic)、非同步程式中的控制流程 (C# 和 Visual Basic)和非同步方法的傳回型別 (C# and Visual Basic)。