Main() et arguments de ligne de commande
La méthode Main
est le point d’entrée d’une application C#. (Les bibliothèques et les services ne nécessitent pas de méthode Main
comme point d’entrée.) Lorsque l’application est démarrée, la méthode Main
est la première méthode appelée.
Il ne peut y avoir qu’un seul point d’entrée dans un programme C#. Si plusieurs classes ont une méthode Main
, vous devez compiler votre programme avec l’option de compilateur StartupObject pour spécifier quelle méthode Main
utiliser comme point d’entrée. Pour plus d’informations, consultez StartupObject (Options du compilateur C#).
class TestClass
{
static void Main(string[] args)
{
// Display the number of command line arguments.
Console.WriteLine(args.Length);
}
}
À partir de C# 9, vous pouvez omettre la méthode Main
et écrire des instructions C# comme si elles se trouvaient dans la méthode Main
, comme dans l’exemple suivant :
using System.Text;
StringBuilder builder = new();
builder.AppendLine("Hello");
builder.AppendLine("World!");
Console.WriteLine(builder.ToString());
Pour plus d’informations sur l’écriture du code d’application avec une méthode de point d’entrée implicite, consultez Instructions de niveau supérieur.
Vue d’ensemble
- La méthode
Main
est le point d’entrée d’un programme exécutable ; c’est l’endroit où le contrôle du programme commence et se termine. Main
est déclaré à l’intérieur d’une classe ou d’un struct.Main
doit êtrestatic
et ne doit pas êtrepublic
. (Dans l’exemple précédent, il reçoit l’accès par défaut deprivate
.) La classe ou le struct englobant n’a pas besoin d’être statique.Main
peut avoir le type de retourvoid
,int
,Task
, ouTask<int>
.- Si et seulement si
Main
retourne unTask
ouTask<int>
, la déclaration deMain
peut inclure le modificateurasync
. Cela exclut spécifiquement une méthodeasync void Main
. - La méthode
Main
peut être déclarée avec ou sans paramètrestring[]
, qui contient des arguments de ligne de commande. Lorsque vous utilisez Visual Studio pour créer des applications Windows, vous pouvez ajouter le paramètre manuellement ou bien utiliser la méthode GetCommandLineArgs() pour obtenir les arguments de ligne de commande. Les paramètres sont lus comme des arguments de ligne de commande avec index de base zéro. Contrairement à C et C++, le nom du programme n’est pas traité comme le premier argument de ligne de commande du tableauargs
, mais il s’agit du premier élément de la méthode GetCommandLineArgs().
La liste suivante affiche les signatures Main
valides :
public static void Main() { }
public static int Main() { }
public static void Main(string[] args) { }
public static int Main(string[] args) { }
public static async Task Main() { }
public static async Task<int> Main() { }
public static async Task Main(string[] args) { }
public static async Task<int> Main(string[] args) { }
Les exemples précédents utilisent tous le modificateur d’accesseur public
. C’est commun, mais pas obligatoire.
L’ajout des types de retour async
et Task
, Task<int>
simplifie le code de programme lorsque les applications de console doivent démarrer et await
des opérations asynchrones dans Main
.
Valeurs de retour Main()
Vous pouvez renvoyer un int
à la méthode Main
en définissant la méthode de l’une des manières suivantes :
Code de la méthode Main |
Signature Main |
---|---|
Aucune utilisation de args ou await |
static int Main() |
Utilise args , aucune utilisation de await |
static int Main(string[] args) |
Aucune utilisation de args , utilise await |
static async Task<int> Main() |
Utilise args et await |
static async Task<int> Main(string[] args) |
Si la valeur de retour de Main
n’est pas utilisée, retourner void
ou Task
permet d’avoir un code un peu plus simple.
Code de la méthode Main |
Signature Main |
---|---|
Aucune utilisation de args ou await |
static void Main() |
Utilise args , aucune utilisation de await |
static void Main(string[] args) |
Aucune utilisation de args , utilise await |
static async Task Main() |
Utilise args et await |
static async Task Main(string[] args) |
Cependant, retourner int
ou Task<int>
permet au programme de communiquer des informations d’état à d’autres programmes ou scripts qui appellent le fichier exécutable.
L’exemple suivant montre comment accéder au code de sortie du processus.
Cet exemple utilise les outils de ligne de commande .NET Core. Si vous ne connaissez pas les outils de ligne de commande .NET Core, vous pouvez les découvrir dans cet article Bien démarrer.
Créez une application en exécutant dotnet new console
. Modifiez la méthode Main
dans Program.cs comme suit :
// Save this program as MainReturnValTest.cs.
class MainReturnValTest
{
static int Main()
{
//...
return 0;
}
}
Quand un programme est exécuté dans Windows, toute valeur retournée par la fonction Main
est stockée dans une variable d’environnement. Cette variable d’environnement peut être récupérée à l’aide de ERRORLEVEL
dans un fichier de commandes ou de $LastExitCode
dans PowerShell.
Vous pouvez générer l’application à l’aide de la commande dotnet CLIdotnet build
.
Ensuite, créez un script PowerShell pour exécuter l’application et afficher le résultat. Collez le code suivant dans un fichier texte et enregistrez-le sous test.ps1
dans le dossier qui contient le projet. Exécutez le script PowerShell en tapant test.ps1
à l’invite de PowerShell.
Comme le code retourne zéro, le fichier de commandes indique la réussite. Toutefois, si vous modifiez MainReturnValTest.cs pour qu’il retourne une valeur différente de zéro, puis que vous recompilez le programme, l’exécution suivante du script PowerShell indique un échec.
dotnet run
if ($LastExitCode -eq 0) {
Write-Host "Execution succeeded"
} else
{
Write-Host "Execution Failed"
}
Write-Host "Return value = " $LastExitCode
Execution succeeded
Return value = 0
Valeurs de retour d’Async Main
Lorsque vous déclarez une async
valeur renvoyée pour Main
, le compilateur génère le code réutilisable pour appeler des méthodes asynchrones dans Main
. Si vous ne spécifiez pas le mot clé async
, vous devez écrire ce code vous-même, comme illustré dans l’exemple suivant. Le code de l’exemple garantit que votre programme s’exécute jusqu’à ce que l’opération asynchrone soit terminée :
public static void Main()
{
AsyncConsoleWork().GetAwaiter().GetResult();
}
private static async Task<int> AsyncConsoleWork()
{
// Main body here
return 0;
}
Ce code réutilisable peut être remplacé par :
static async Task<int> Main(string[] args)
{
return await AsyncConsoleWork();
}
L’avantage de déclarerMain
comme async
est que le compilateur génère toujours un code correct.
Quand le point d’entrée de l’application retourne Task
ou Task<int>
, le compilateur génère un nouveau point d’entrée qui appelle la méthode de point d’entrée déclarée dans le code d’application. En supposant que ce point d’entrée est appelé $GeneratedMain
, le compilateur génère le code suivant pour ces points d’entrée :
static Task Main()
permet au compilateur d’émettre l’équivalent deprivate static void $GeneratedMain() => Main().GetAwaiter().GetResult();
static Task Main(string[])
permet au compilateur d’émettre l’équivalent deprivate static void $GeneratedMain(string[] args) => Main(args).GetAwaiter().GetResult();
static Task<int> Main()
permet au compilateur d’émettre l’équivalent deprivate static int $GeneratedMain() => Main().GetAwaiter().GetResult();
static Task<int> Main(string[])
permet au compilateur d’émettre l’équivalent deprivate static int $GeneratedMain(string[] args) => Main(args).GetAwaiter().GetResult();
Notes
Si les exemples ont utilisé le modificateur async
sur la méthode Main
, le compilateur génère le même code.
Arguments de ligne de commande
Vous pouvez envoyer des arguments à la méthode Main
en définissant la méthode de l’une des manières suivantes :
Code de la méthode Main |
Signature Main |
---|---|
Aucune valeur renvoyée, aucune utilisation de await |
static void Main(string[] args) |
Valeur renvoyée, aucune utilisation de await |
static int Main(string[] args) |
Aucune valeur renvoyée, utilise await |
static async Task Main(string[] args) |
Valeur renvoyée, utilise await |
static async Task<int> Main(string[] args) |
Si les arguments ne sont pas utilisés, vous pouvez omettre args
de la signature de méthode pour du code légèrement plus simple :
Code de la méthode Main |
Signature Main |
---|---|
Aucune valeur renvoyée, aucune utilisation de await |
static void Main() |
Valeur renvoyée, aucune utilisation de await |
static int Main() |
Aucune valeur renvoyée, utilise await |
static async Task Main() |
Valeur renvoyée, utilise await |
static async Task<int> Main() |
Notes
Vous pouvez également utiliser Environment.CommandLine ou Environment.GetCommandLineArgs pour accéder aux arguments de ligne de commande à partir de n’importe quel emplacement d’une application console ou Windows Forms. Pour activer des arguments de ligne de commande dans la méthode de signature Main
dans une application Windows Forms, vous devez modifier manuellement la signature de Main
. Le code généré par Windows Forms crée Main
sans paramètre d’entrée.
Le paramètre de la méthode Main
est un tableau String qui représente les arguments de ligne de commande. En général, vous déterminez s’il existe des arguments en testant la propriété Length
, par exemple :
if (args.Length == 0)
{
System.Console.WriteLine("Please enter a numeric argument.");
return 1;
}
Conseil
Le tableau args
ne peut pas être null. Par conséquent, il est sûr d’accéder à la propriété Length
sans vérification de la valeur Null.
Vous pouvez également convertir les arguments de chaîne en types numériques à l’aide de la classe Convert ou de la méthode Parse
. Par exemple, l’instruction suivante convertit string
en nombre long
en utilisant la méthode Parse :
long num = Int64.Parse(args[0]);
Il est également possible d’utiliser le type C# long
, qui sert d’alias à Int64
:
long num = long.Parse(args[0]);
Vous pouvez également utiliser la méthode ToInt64
de la classe Convert
pour obtenir le même résultat :
long num = Convert.ToInt64(s);
Pour plus d’informations, consultez Parse et Convert.
L’exemple suivant montre comment utiliser des arguments de ligne de commande dans une application console. L’application prend un argument au moment de l’exécution, le convertit en entier, puis calcule la factorielle du nombre. Si aucun argument n’est fourni, l’application affiche un message pour expliquer comment le programme doit être utilisé.
Pour compiler et exécuter l’application à partir d’une invite de commandes, procédez comme suit :
Collez le code suivant dans un éditeur de texte, puis enregistrez le fichier en tant que fichier texte sous le nom Factorial.cs.
public class Functions { public static long Factorial(int n) { // Test for invalid input. if ((n < 0) || (n > 20)) { return -1; } // Calculate the factorial iteratively rather than recursively. long tempResult = 1; for (int i = 1; i <= n; i++) { tempResult *= i; } return tempResult; } } class MainClass { static int Main(string[] args) { // Test if input arguments were supplied. if (args.Length == 0) { Console.WriteLine("Please enter a numeric argument."); Console.WriteLine("Usage: Factorial <num>"); return 1; } // Try to convert the input arguments to numbers. This will throw // an exception if the argument is not a number. // num = int.Parse(args[0]); int num; bool test = int.TryParse(args[0], out num); if (!test) { Console.WriteLine("Please enter a numeric argument."); Console.WriteLine("Usage: Factorial <num>"); return 1; } // Calculate factorial. long result = Functions.Factorial(num); // Print result. if (result == -1) Console.WriteLine("Input must be >= 0 and <= 20."); else Console.WriteLine($"The Factorial of {num} is {result}."); return 0; } } // If 3 is entered on command line, the // output reads: The factorial of 3 is 6.
Dans l’écran Démarrer ou le menu Démarrer, ouvrez une fenêtre Invite de commandes développeur Visual Studio, puis accédez au dossier qui contient le fichier que vous avez créé.
Entrez la commande suivante pour compiler l’application.
dotnet build
Si votre application ne contient pas d’erreurs de compilation, un fichier exécutable nommé Factorial.exe est créé.
Entrez la commande suivante pour calculer la factorielle de 3 :
dotnet run -- 3
Cette commande génère la sortie suivante :
The factorial of 3 is 6.
Notes
Quand vous exécutez une application dans Visual Studio, vous pouvez spécifier des arguments de ligne de commande dans la page Déboguer du Concepteur de projet.
spécification du langage C#
Pour plus d'informations, voir la spécification du langage C#. La spécification du langage est la source de référence pour la syntaxe C# et son utilisation.