Sample code and snippets used in the .NET documentation
Branch: master
Clone or download
Potapy4 and BillWagner Fix comment (#666)
Fixes #1933
Latest commit 1ce45d4 Feb 22, 2019

README.md

.NET Samples

This repo contains all the sample code that is part of any topic under the .NET documentation. There are several different projects that are organized in sub-folders. These sub-folders are organized similarly to the organization of the docs for .NET. Some of the articles will have more than one sample associated with them.

The content team tracks issues for .NET documentation in the dotnet/docs and dotnet/dotnet-api-docs repositories. Issues are turned off on this repository. File issues against existing samples and suggestions for new samples in those repositories. If you're not sure where, choose dotnet/docs. This process keeps the issues associated with the articles that explain the concepts for each sample. The best process is to file an issue from the feedback control at the bottom of each docs page:

  • For existing samples, file the issue on the page with the sample.
  • To suggest new samples, file the issue on the index page where you want to see the new sample.

There are two classes of code in this repository:

  • Snippets represent small focused examples that demonstrate one feature or syntax. These should be no more than a single screen of code.
  • Samples represent programs that demonstrate application or library scenarios. These samples are typically larger than snippets, and often use more than one technology, feature, or toolkit. The readme.md file for each sample will refer to the article so that you can read more about the concepts covered in each sample.

Both samples and snippets should be buildable projects. Those projects should build and run on the widest set of platforms possible for the given sample. In practice, that means building .NET Core-based console applications where possible. Samples that are specific to the web or a UI framework should add those tools as needed. Examples include web applications, mobile apps, WPF or WinForms apps, and so on.

We are working toward having a CI system in place for all code. When you make any updates to samples, make sure each update is part of a buildable project. Ideally, add tests for correctness on samples as well.

Snippets

Snippets are extracted from small programs that include the snippet. Snippets are all located in the top level /snippets folder. While snippets are small blocks of code, we want to move toward snippets that are part of buildable sample projects.

Building a snippet or sample

You build any .NET Core snippet or sample using the .NET Core CLI, which can be installed with the .NET Core SDK. Then, execute these commands from the CLI in the directory of any sample:

dotnet build
dotnet run

These will install any needed dependencies, build the project, and run the project respectively.

Multi-project samples have instructions in their root directory in a README.md file.

Except where noted, all samples build from the command line on any platform supported by .NET Core. There are a few samples that are specific to Visual Studio and require Visual Studio 2017 or later. In addition, some samples show platform specific features and will require a specific platform. Other samples and snippets require the .NET Framework and will run on Windows platforms, and will need the Developer Pack for the target Framework version.

Creating new samples or snippets

If you wish to add a code sample:

  1. Your sample must be part of a buildable project. Where possible, the projects should build on all platforms supported by .NET Core. Exceptions to this are samples that demonstrate a platform specific feature or platform specific tool.

  2. Your sample should conform to the corefx coding style to maintain consistency.

    • Additionally, we prefer the use of static methods rather than instance methods when demonstrating something that doesn't require instantiating a new object.
  3. Your sample should include appropriate exception handling. It should handle all exceptions that are likely to be thrown in the context of the sample. For example, a sample that calls the Console.ReadLine method to retrieve user input should use appropriate exception handling when the input string is passed as an argument to a method. Similarly, if your sample expects a method call to fail, the resulting exception must be handled. Always handle the specific exceptions thrown by the method, rather than base class exceptions such as Exception or SystemException.

  4. If your sample builds a standalone package, you must include the runtimes used by our CI build system, in addition to any runtimes used by your sample:

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

We will have a CI system in place to build these projects shortly.

To create a sample:

  1. File an issue or add a comment to an existing one that you are working on it.
  2. Write the topic that explains the concepts demonstrated in your sample (example: docs/standard/linq/where-clause.md).
  3. Write your sample (example: WhereClause-Sample1.cs).
  4. Create a Program.cs with a Main entry point that calls your samples. If there is already one there, add the call to your sample:
    public class Program
    {
        public void Main(string[] args)
        {
            WhereClause1.QuerySyntaxExample();
    
            // Add the method syntax as an example.
            WhereClause1.MethodSyntaxExample();
        }
    }

To build and run your sample:

  1. Go to the sample folder and build to check for errors:

    dotnet build
  2. Run your sample:

    dotnet run
  3. Add a readme.md to the root directory of your sample.

    This should include a brief description of the code, and refer people to the article that references the sample.