samples

Muestras .net

Este repositorio contiene todo el código de muestra que forma parte de cualquier tema bajo la documentación .NET. Hay varios proyectos diferentes que se organizan en subcarpetas. Estos subcarpetas están organizados de manera similar a la organización de los documentos para .NET. Algunos de los artículos tendrán más de una muestra asociada con ellos.

El equipo de contenido rastrea los problemas para la documentación de .NET en los repositorios Dotnet/Docs y Dotnet/Dotnet-API-Docs. Los problemas se desactivan en este repositorio. Archive los problemas contra muestras existentes y sugerencias para nuevas muestras en esos repositorios. Si no está seguro de dónde, elija Dotnet/Docs. Este proceso mantiene los problemas asociados con los artículos que explican los conceptos para cada muestra. El mejor proceso es presentar un problema del control de comentarios en la parte inferior de cada página de documentos:

• Para las muestras existentes, presente el problema en la página con la muestra.
• Para sugerir nuevas muestras, presente el problema en la página de índice donde desea ver la nueva muestra.

El código en este repositorio representa programas que demuestran escenarios de aplicación o biblioteca. Estas muestras a menudo usan más de una tecnología, característica o kit de herramientas. Cada muestra tiene un archivo ReadMe.md que explica la muestra y los enlaces a los recursos para obtener más información.

Las muestras deben ser proyectos edificables. Esos proyectos deben construir y ejecutar en el conjunto más amplio de plataformas posibles para la muestra dada. En la práctica, eso significa construir aplicaciones de consola basadas en el núcleo .NET cuando sea posible. Las muestras que son específicas de la web o un marco de la interfaz de usuario deben agregar esas herramientas según sea necesario. Los ejemplos incluyen aplicaciones web, aplicaciones móviles, aplicaciones de formularios WPF o Windows, etc.

Estamos trabajando para tener un sistema CI en su lugar para todo el código. Cuando realice cualquier actualización de las muestras, asegúrese de que cada actualización sea parte de un proyecto edificable. Idealmente, agregue pruebas para la corrección también en las muestras.

Construir una muestra

Construya cualquier muestra de Core .NET utilizando la CLI .NET Core, que se instala con el SDK .NET Core. Luego ejecute estos comandos desde la CLI en el directorio de cualquier muestra:

 dotnet build
dotnet run

Estos instalarán las dependencias necesarias, construirán el proyecto y ejecutarán el proyecto respectivamente.

Las muestras de proyectos múltiples tienen instrucciones en su directorio raíz en un archivo README.md .

Excepto cuando se indique, todas las muestras se construyen desde la línea de comando en cualquier plataforma compatible con .NET Core. Hay algunas muestras que son específicas de Visual Studio y requieren Visual Studio 2017 o posterior. Además, algunas muestras muestran características específicas de la plataforma y requerirán una plataforma específica. Otras muestras y fragmentos requieren el marco .NET y se ejecutarán en las plataformas de Windows, y necesitará el paquete de desarrolladores para la versión de Marco de destino.

Creando nuevas muestras

Si desea agregar una muestra de código:

1. Su muestra debe ser parte de un proyecto edificable . Siempre que sea posible, los proyectos deben construir en todas las plataformas compatibles con .NET Core. Las excepciones a esto son muestras que demuestran una función específica de la plataforma o una herramienta específica de la plataforma.

2. Su muestra debe cumplir con el estilo de codificación de tiempo de ejecución para mantener la consistencia.

   • Además, preferimos el uso de métodos static en lugar de métodos de instancia al demostrar algo que no requiere instanciar un nuevo objeto.

3. Su muestra debe incluir el manejo de excepciones adecuado . Debería manejar todas las excepciones que probablemente se arrojen en el contexto de la muestra. Por ejemplo, una muestra que llama al método de consola. Readine para recuperar la entrada del usuario debe usar el manejo de excepción apropiado cuando la cadena de entrada se pasa como argumento a un método. Del mismo modo, si su muestra espera una llamada de método para fallar, la excepción resultante debe manejarse. Siempre maneje las excepciones específicas lanzadas por el método, en lugar de las excepciones de clase base, como la excepción o el systemException.

4. Si su muestra construye un paquete independiente, debe incluir los tiempos de ejecución utilizados por nuestro sistema de compilación CI, además de cualquier horario de ejecución utilizado por su muestra:

   • win7-x64
   • win8-x64
   • win81-x64
   • ubuntu.16.04-x64

Tendremos un sistema CI para construir estos proyectos en breve.

Para crear una muestra:

1. Presente un problema o agregue un comentario a uno existente en el que esté trabajando en él.

2. Escriba el tema que explique los conceptos demostrados en su muestra (ejemplo: docs/standard/linq/where-clause.md ).

3. Escriba su muestra (Ejemplo: WhereClause-sample1.cs ).

4. Cree un programa.cs con un punto de entrada principal que llame a sus muestras. Si ya hay uno allí, agregue la llamada a su muestra:

    public class Program
   {
       public void Main ( string [ ] args )
       {
           WhereClause1 . QuerySyntaxExample ( ) ;
   
           // Add the method syntax as an example.
           WhereClause1 . MethodSyntaxExample ( ) ;
       }
   }

5. No verifique el archivo de solución si contiene solo un proyecto.

Para construir y ejecutar su muestra:

1. Vaya a la carpeta de muestra y compile para verificar los errores:

    dotnet build

2. Ejecute su muestra:

    dotnet run

3. Agregue un ReadMe.md al directorio raíz de su muestra.

   Esto debe incluir una breve descripción del código y remitir a las personas al artículo que hace referencia a la muestra.