samples
verage
Ce dépôt contient tout l'exemple de code qui fait partie de tout sujet sous la documentation .NET. Il existe plusieurs projets différents qui sont organisés dans des sous-reproches. Ces sous-repliants sont organisés de manière similaire à l'organisation des documents pour .NET. Certains articles auront plus d'un échantillon associé.
L'équipe de contenu suit les problèmes pour la documentation .NET dans les référentiels DOTNET / DOCS et DOTNET / DOTNET-API-DOCS. Les problèmes sont désactivés sur ce référentiel. Déposez des problèmes contre les échantillons et suggestions existants pour de nouveaux échantillons dans ces référentiels. Si vous ne savez pas où, choisissez dotnet / docs. Ce processus maintient les problèmes associés aux articles qui expliquent les concepts de chaque échantillon. Le meilleur processus consiste à déposer un problème à partir du contrôle de rétroaction au bas de chaque page Docs:
Le code de ce référentiel représente des programmes qui démontrent des scénarios d'application ou de bibliothèque. Ces échantillons utilisent souvent plus d'une technologie, d'une fonction ou d'une boîte à outils. Chaque échantillon a un fichier readme.md qui explique l'échantillon et les liens vers des ressources pour plus d'informations.
Les échantillons doivent être des projets à constructeur. Ces projets doivent construire et exécuter sur l'ensemble de plateformes le plus large possible pour l'échantillon donné. Dans la pratique, cela signifie la construction d'applications de console basées sur le noyau .NET dans la mesure du possible. Les échantillons spécifiques au Web ou à un cadre d'interface utilisateur doivent ajouter ces outils selon les besoins. Les exemples incluent les applications Web, les applications mobiles, les applications WPF ou Windows Forms, etc.
Nous travaillons à la mise en place d'un système CI pour tout le code. Lorsque vous effectuez des mises à jour des échantillons, assurez-vous que chaque mise à jour fait partie d'un projet à constructeur. Idéalement, ajoutez également des tests d'exactitude sur les échantillons.
Créez n'importe quel échantillon de noyau .NET à l'aide de la CLI .NET Core, qui est installée avec le SDK .NET Core. Ensuite, exécutez ces commandes à partir de la CLI dans le répertoire de tout échantillon:
dotnet build
dotnet runCeux-ci installeront toutes les dépendances nécessaires, construisent le projet et exécuteront respectivement le projet.
Les échantillons multi-projets ont des instructions dans leur répertoire racine dans un fichier README.md .
Sauf si indiqué, tous les échantillons construisent à partir de la ligne de commande sur n'importe quelle plate-forme pris en charge par .NET Core. Il existe quelques échantillons spécifiques à Visual Studio et nécessitent Visual Studio 2017 ou version ultérieure. De plus, certains échantillons présentent des fonctionnalités spécifiques à la plate-forme et nécessiteront une plate-forme spécifique. D'autres échantillons et extraits nécessitent le Framework .NET et s'exécuteront sur les plates-formes Windows, et auront besoin du pack de développeurs pour la version Target Framework.
Si vous souhaitez ajouter un échantillon de code:
Votre échantillon doit faire partie d'un projet à constructeur . Dans la mesure du possible, les projets doivent s'appuyer sur toutes les plateformes prises en charge par .NET Core. Les exceptions à cela sont des échantillons qui démontrent une fonctionnalité spécifique à la plate-forme ou un outil spécifique à la plate-forme.
Votre échantillon doit être conforme au style de codage d'exécution pour maintenir la cohérence.
static plutôt que les méthodes d'instance lors de la démonstration de quelque chose qui ne nécessite pas d'instantir un nouvel objet.Votre échantillon doit inclure une gestion des exceptions appropriée . Il devrait gérer toutes les exceptions susceptibles d'être jetées dans le contexte de l'échantillon. Par exemple, un échantillon qui appelle la méthode Console.Readline pour récupérer l'entrée utilisateur doit utiliser la gestion des exceptions appropriée lorsque la chaîne d'entrée est passé comme argument à une méthode. De même, si votre échantillon s'attend à ce qu'un appel de méthode échoue, l'exception résultante doit être gérée. Gérez toujours les exceptions spécifiques lancées par la méthode, plutôt que des exceptions de classe de base telles que Exception ou SystemException.
Si votre échantillon construit un package autonome, vous devez inclure les temps d'exécution utilisés par notre système de construction CI, en plus de tout temps utilisé par votre échantillon:
win7-x64win8-x64win81-x64ubuntu.16.04-x64Nous aurons un système CI en place pour construire ces projets sous peu.
Pour créer un échantillon:
Déposez un problème ou ajoutez un commentaire à un commentaire existant sur lequel vous y travaillez.
Écrivez le sujet qui explique les concepts démontrés dans votre exemple (exemple: docs/standard/linq/where-clause.md ).
Écrivez votre exemple (exemple: whereclause-échantillon1.cs ).
Créez un programme.cs avec un point d'entrée principal qui appelle vos échantillons. S'il y en a déjà un, ajoutez l'appel à votre échantillon:
public class Program
{
public void Main ( string [ ] args )
{
WhereClause1 . QuerySyntaxExample ( ) ;
// Add the method syntax as an example.
WhereClause1 . MethodSyntaxExample ( ) ;
}
}Ne vérifiez pas le fichier de solution s'il ne contient qu'un seul projet.
Pour construire et gérer votre échantillon:
Accédez au dossier de l'échantillon et créez pour vérifier les erreurs:
dotnet buildExécutez votre échantillon:
dotnet runAjoutez un Readme.md au répertoire racine de votre échantillon.
Cela devrait inclure une brève description du code et renvoyer les gens à l'article qui fait référence à l'échantillon.
