samples

.NET Amostras

Este repo contém todo o código de amostra que faz parte de qualquer tópico sob a documentação .NET. Existem vários projetos diferentes que são organizados em subpastos. Esses sub-foldes são organizados de maneira semelhante à organização dos documentos para .NET. Alguns dos artigos terão mais de uma amostra associada a eles.

A equipe de conteúdo rastreia questões para a documentação do .NET nos repositórios DOTNET/DOCs e DOTNET/DOTNET-API-DOCS. Questões são desativadas neste repositório. Arquivo de problemas contra amostras e sugestões existentes para novas amostras nesses repositórios. Se você não tiver certeza de onde, escolha Dotnet/Docs. Esse processo mantém os problemas associados aos artigos que explicam os conceitos para cada amostra. O melhor processo é arquivar um problema do controle de feedback na parte inferior de cada página dos documentos:

• Para amostras existentes, arquive o problema na página com a amostra.
• Para sugerir novas amostras, arquive o problema na página de índice em que você deseja ver a nova amostra.

O código neste repositório representa programas que demonstram cenários de aplicativos ou bibliotecas. Essas amostras geralmente usam mais de uma tecnologia, característica ou kit de ferramentas. Cada amostra possui um arquivo readme.md que explica a amostra e os links para recursos para obter mais informações.

As amostras devem ser projetos edificáveis. Esses projetos devem construir e executar o conjunto mais amplo de plataformas possíveis para a amostra fornecida. Na prática, isso significa criar aplicativos de console baseados no núcleo .NET, sempre que possível. As amostras específicas para a Web ou uma estrutura de interface do usuário devem adicionar essas ferramentas conforme necessário. Os exemplos incluem aplicativos da Web, aplicativos móveis, aplicativos WPF ou Windows Forms e assim por diante.

Estamos trabalhando para ter um sistema de IC para todo o código. Quando você faz alguma atualização para amostras, verifique se cada atualização faz parte de um projeto construída. Idealmente, adicione testes para correção nas amostras também.

Construindo uma amostra

Construa qualquer amostra .NET Core usando a CLI .NET Core, instalada com o .NET Core SDK. Em seguida, execute esses comandos da CLI no diretório de qualquer amostra:

 dotnet build
dotnet run

Isso instalará as dependências necessárias, criará o projeto e executará o projeto, respectivamente.

As amostras de vários projetos têm instruções em seu diretório raiz em um arquivo README.md .

Exceto onde observado, todas as amostras são criadas a partir da linha de comando em qualquer plataforma suportada pelo .NET Core. Existem algumas amostras específicas para o Visual Studio e requerem o Visual Studio 2017 ou posterior. Além disso, algumas amostras mostram recursos específicos da plataforma e exigirão uma plataforma específica. Outras amostras e trechos exigem a estrutura .NET e serão executados nas plataformas do Windows e precisarão do pacote de desenvolvedor para a versão de estrutura de destino.

Criando novas amostras

Se você deseja adicionar uma amostra de código:

1. Sua amostra deve fazer parte de um projeto edificável . Sempre que possível, os projetos devem se basear em todas as plataformas suportadas pelo .NET Core. Exceções a isso são amostras que demonstram um recurso específico da plataforma ou uma ferramenta específica da plataforma.

2. Sua amostra deve estar em conformidade com o estilo de codificação de tempo de execução para manter a consistência.

   • Além disso, preferimos o uso de métodos static , em vez de métodos de instância ao demonstrar algo que não requer instanciando um novo objeto.

3. Sua amostra deve incluir o manuseio de exceção apropriado . Ele deve lidar com todas as exceções que provavelmente serão lançadas no contexto da amostra. Por exemplo, uma amostra que chama o método do console.readline para recuperar a entrada do usuário deve usar o manuseio de exceção apropriado quando a sequência de entrada é passada como um argumento para um método. Da mesma forma, se o seu exemplo espera que uma chamada de método falhe, a exceção resultante deve ser tratada. Sempre lide com as exceções específicas lançadas pelo método, em vez de exceções de classe base, como exceção ou SystemException.

4. Se a sua amostra criar um pacote independente, você deverá incluir os horários de execução usados ​​pelo nosso sistema de compilação de CI, além de qualquer momento usado pela sua amostra:

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

Teremos um sistema de IC para construir esses projetos em breve.

Para criar uma amostra:

1. Arquive um problema ou adicione um comentário a um existente em que você está trabalhando nele.

2. Escreva o tópico que explica os conceitos demonstrados em sua amostra (exemplo: docs/standard/linq/where-clause.md ).

3. Escreva sua amostra (Exemplo: WhereClause-Sample1.cs ).

4. Crie um programa.cs com um ponto de entrada principal que chama suas amostras. Se já houver um lá, adicione a chamada à sua amostra:

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

5. Não verifique o arquivo de solução se ele contiver apenas um projeto.

Para construir e executar sua amostra:

1. Vá para a pasta de amostra e construa para verificar se há erros:

    dotnet build

2. Execute sua amostra:

    dotnet run

3. Adicione um readme.md ao diretório raiz da sua amostra.

   Isso deve incluir uma breve descrição do código e encaminhar pessoas ao artigo que referencia a amostra.