エントリーポイント

2020/07/05

キーワード

エントリーポイント
トップレベルステートメント

概要

実行可能なプログラムを書くとき、最初に呼び出される処理をエントリーポイント(entry point: 入場地点、入り口)と言います。 C# の場合、通常、Main という名前の静的メソッドを1個だけ書くことで、このメソッドがエントリーポイントになります。

また、複数の Main メソッドを書いてそのうちの1つをエントリーポイントに選ぶ方法があったり、 C# 9.0 からはトップレベルステートメントという書き方でエントリーポイントを作れたりします。

本項ではこの C# のエントリーポイントに関する仕様について説明します。

C# のエントリーポイント

C# 関連のチュートリアルでのサンプルコードや、テンプレート通りに C# プログラムを新規作成すると以下のような内容になっていることが多いと思います。

using System;
 
namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");
        }
    }
}

C# の仕様上、実行可能プログラムを C# で書きたい場合、どこかに1つ、Main という名前のメソッドが必要です。 (後述しますが、C# 9.0 からは別の方法も追加されました。)

名前空間は必須ではありません。クラス名も何でも構いません。例えば以下のようなコードでも、Main メソッドがエントリーポイントになります。

using System;
 
class X
{
    static void Main(string[] args)
    {
        Console.WriteLine("Hello World!");
    }
}

通常、エントリーポイントとして使うためには、Main メソッドに以下のような制限があります。

静的である(static 修飾子が付いてる)必要がある
引数はなしか、string[] のどちらか
戻り値はなし(void)か、int のどちらか
- C# 7.1 以降は追加で Task か Task<int> も OK

つまり、C# 7.0 以前だと以下の4つのうちのいずれかが、

static void Main()
static void Main(string[] args)
static int Main()
static int Main(string[] args)

加えて、C# 7.1 以降だと以下の4つのうちのいずれかが認められます。

using System.Threading.Tasks;
 
static Task Main()
static Task Main(string[] args)
static Task<int> Main()
static Task<int> Main(string[] args)

.NET のエントリーポイント

前述の Main という名前が必須なのは C# の仕様上の話で、その下層、 .NET ランタイムにはそういう制限はありません。 .entrypoint ディレクティブで修飾したメソッドがエントリーポイントになります。

例えば、以下のような .NET IL アセンブラーコードを書けば、A というクラス内の B というメソッドをエントリーポイントにできます。

.class public auto ansi beforefieldinit A
       extends [mscorlib]System.Object
{
  .method public hidebysig static void B(string[] args) cil managed
  {
    .entrypoint
    .maxstack  8
    IL_0000:  ldstr      "Hello World!"
    IL_0005:  call       void [mscorlib]System.Console::WriteLine(string)
    IL_000a:  nop
    IL_000b:  ret
  }
}

逆に .NET ランタイム的には Task 戻り値のエントリーポイントを認めていなくて、 C# 7.1 の非同期 Main は、C# コンパイラーが以下のようなコードに相当する IL を生成しています。

using System.Threading.Tasks;
 
class Program
{
    // C# 7.1 以降書ける「非同期 Main」。
    static async Task Main()
    {
    }
 
    // 非同期 Main から C# コンパイラーが自動生成するメソッド。
    // これに .entrypoint ディレクティブが付く。
    static void <Main>()
    {
        Main().GetAwaiter().GetResult();
    }
}

複数の Main メソッドからエントリーポイントを選択

C# で複数のクラスに Main メソッドを書くこともできますが、素の状態ではコンパイルエラーになります。 (エラー内容は「複数のエントリーポイントが定義されています」。)

class A
{
    static void Main()
    {
    }
}
 
class B
{
    static void Main()
    {
    }
}

ただ、オプションによってこのうちのどれをエントリーポイントにするかを指定する方法があります。 csc (C# コンパイラー)を直接呼び出す場合は -main オプションを、

csc -main:A

csproj (プロジェクト)に設定を書く場合は StartupObject タグでクラス名を指定します。

<Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net5.0</TargetFramework>
    <StartupObject>A</StartupObject>
  </PropertyGroup>
 
</Project>

この例の場合は、この書き方で、A.Main の方がエントリーポイントになります。

トップレベルステートメント

Ver. 9.0

C# 9.0 から、トップレベル(top-leve: クラスや名前空間よりも外側、ファイル直下)にステートメントを直接書けるようになりました。

例えば前述の「Hello World」であれば、単に以下のように書けるようになります。

using System;
Console.WriteLine("Hello World!");

この機能をトップレベルステートメント(top-level statements)と言います。

挙動としては、Mainに相当するメソッドの自動生成になります。上記の例の場合、以下のようなコードが生成された上で、$Main メソッドに .entrypoint が付きます。

using System;
 
class <Program>$
{
    static void $Main(string[] args)
    {
        Console.WriteLine("Hello World!");
    }
}

クラス名もメソッド名も、通常の C# コードでは定義できない・呼び出しできない名前で生成されます^※。名前も決まった名前にはなっていません(今現在の実装が $Main という名前で生成しているからといって、将来ずっとこの名前とは限らない)。

^※ C# 10.0 以降は、クラス名に関しては Program という普通の名前に変更されました。メソッド名の方は <Main>$ になっています。

ステートメントを書ける場所

トップレベルステートメントを書ける場所には少し制約があります。

プロジェクト全体で1ファイルだけがトップレベルステートメントを持てる
クラスや名前空間よりも上にだけトップレベルステートメントを書ける

要は、実行順序で迷いそうになったり、不慮の事故で予定外の処理を足してしまったりすることがないように、書ける場所を1か所に絞っています。

例えば以下のようなコードはコンパイルエラーになります。

using System;
 
// ここにステートメントを書くのは OK。
Console.WriteLine("above class");
 
class Program
{
    void M() { }
}
 
// ここにステートメントを書くのはダメ。
Console.WriteLine("below class");

トップレベルにメソッド記述

トップレベルにはメソッドを書くこともできます。これは扱いとしては、生成される Main (相当の)メソッドのローカル関数になります。

例えば以下のようなコードを書いた場合、

void m(string s) => System.Console.WriteLine(s);
 
m("abc");
m("123");

コンパイラーが生成するコードは以下のような感じになります。

class <Program>$
{
    static void $Main(string[] args)
    {
        void m(string s) => System.Console.WriteLine(s);
 
        m("abc");
        m("123");
    }
}

ただ、定義したメソッドの名前はプロジェクト全域に影響を及ぼします。以下のように、「メソッドがあることは全域で見えているけども、使ってはいけない」という扱いを受けます。

void m(string s) => System.Console.WriteLine(s);
 
m("abc");
m("123");
 
class Program
{
    static void M()
    {
        // ここはエラーになるものの、エラー内容は
        // 「m が見つからない」ではなく、
        // 「トップ レベルで定義した m をここから使うことはできない」になる。
        m("Program.M");
    }
}

(将来的に、トップレベルで定義したメソッドを、ローカル関数扱いからグローバル関数(どこからでも参照できる静的メソッド)扱いに変更する可能性もなくはなく、その場合、C# 9.0 時点ではこの例のようなエラーにしておく方が将来の憂いがないみたいです。)

トップレベルステートメントとスクリプト実行

今の C# にはスクリプト実行用の文法もあったりするんですが、それとトップレベルステートメントは微妙に仕様が違っていたりします。

スクリプト実行の場合にはクラスの後ろにもステートメントを書けます。また、#r や #load など、一部のディレクティブはスクリプト実行専用です。スクリプト実行では、; なしで式を書くと、その値をREPL(Read Eval Print Loop: 1行式を評価しては、即座にその値を画面に表示する)実行できたりします。

例えば、以下のコードはスクリプト実行では有効ですが、トップレベルステートメントとしてはコンパイルエラーになります。

struct Point
{
    public int X;
    public int Y;
}
 
var p = new Point { X = 1, Y = 2 };
 
p.X
p.Y

一方で、スクリプト実行では名前空間を書けないので、例えば以下のコードはトップレベルステートメントでだけコンパイルできます。

var p = new App1.Point { X = 1, Y = 2 };
 
namespace App1
{
    struct Point
    {
        public int X;
        public int Y;
    }
}

コマンドライン引数と戻り値

トップレベルステートメントを使う場合、暗黙的に args という名前の変数が定義されていて、この変数にはコマンドライン引数(Main メソッドを書いた時、string[] 引数に入っているのと同じもの)が入っています。

また、トップレベルステートメントには return を書くことができますが、int 戻り値の Main メソッドと同じ意味になります(プログラムの終了コードになる)。

例えば以下のようなトップレベルステートメントを書けます。

if (args.Length == 0)
{
    System.Console.WriteLine("コマンドライン引数が必要です");
    return 1;
}
else
{
    System.Console.WriteLine(args[0]);
    return 0;
}

このコードは以下のような意味で解釈されます。

class <Program>$
{
    static int $Main(string[] args)
    {
        if (args.Length == 0)
        {
            System.Console.WriteLine("コマンドライン引数が必要です");
            return 1;
        }
        else
        {
            System.Console.WriteLine(args[0]);
            return 0;
        }
    }
}

return がない時には void Main(string[] args) で、あるときには int Main(string[] args) 相当のコードが生成されます。

ちなみに、トップレベルステートメント中には await を書けます。 await があるときに限って、Task Main(string[] args) 、 Task<int> Main(string[] args) 相当のコード生成になります。

更新履歴

2023/10/24

コレクション式

[C#]

2023/09/20

[雑記] InlineArray

[C#]

2023/07/29

更新：ローカル関数と匿名関数

[C#]

2023/06/21

C# 12.0 の新機能

[C#]

2023/04/15

[雑記] 明確な代入ルール

[C#]

ブログ

2024/04/04

エントリーポイント

目次

キーワード

概要

C# のエントリーポイント

.NET のエントリーポイント

複数の Main メソッドからエントリーポイントを選択

トップレベルステートメント

Ver. 9.0

ステートメントを書ける場所

トップレベルにメソッド記述

トップレベルステートメントとスクリプト実行

コマンドライン引数と戻り値

更新履歴

コレクション式

[雑記] InlineArray

更新：ローカル関数と匿名関数

C# 12.0 の新機能

[雑記] 明確な代入ルール

ブログ

ref/ref struct 変数を非同期メソッド中で使えるように

Lock クラス

Extensions (拡張型)

C# 13 でのコレクション式 - ディクショナリ式

C# 13 でのコレクション式 - 制限の緩和の話