diff --git a/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md b/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md index 050c9ea53876b..960c70746dd88 100644 --- a/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md +++ b/docs/csharp/roslyn-sdk/get-started/semantic-analysis.md @@ -16,6 +16,10 @@ This tutorial assumes you're familiar with the Syntax API. The [get started with In this tutorial, you explore the **Symbol** and **Binding APIs**. These APIs provide information about the _semantic meaning_ of a program. They enable you to ask and answer questions about the types represented by any symbol in your program. +You'll need to install the **.NET Compiler Platform SDK**: + +[!INCLUDE[interactive-note](~/includes/roslyn-installation.md)] + ## Understanding Compilations and Symbols As you work more with the .NET Compiler SDK, you become familiar with the distinctions between Syntax API and the Semantic API. The **Syntax API** allows you to look at the _structure_ of a program. However, often you want richer information about the semantics or _meaning_ of a program. While a loose code file or snippet of VB or C# code can be syntactically analyzed in isolation, it's not meaningful to ask questions such as "what's the type of this variable" in a vacuum. The meaning of a type name may be dependent on assembly references, namespace imports, or other code files. Those questions are answered using the **Semantic API**, specifically the class. @@ -28,9 +32,6 @@ Like , [!IMPORTANT] -> The following samples require the **.NET Compiler SDK** installed as part of Visual Studio 2017. You can find the .NET Compiler SDK as the last optional component listed under the **Visual Studio extension development** workload. The templates aren't installed without this component. - You can see the finished code for this sample in [our GitHub repository](https://github.com/dotnet/docs/tree/master/samples/csharp/roslyn-sdk/SemanticQuickStart). > [!NOTE] diff --git a/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md b/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md index 5f5919d7a97cc..861498573b7a6 100644 --- a/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md +++ b/docs/csharp/roslyn-sdk/get-started/syntax-analysis.md @@ -38,6 +38,10 @@ The Syntax API creates a tree structure with the root representing the compilati That brief description provides an overview of the kind of information accessible using the Syntax API. The Syntax API is nothing more than a formal API that describes the familiar code constructs you know from C#. The full capabilities include information about how the code is formatted including line breaks, whitespace, and indenting. Using this information, you can fully represent the code as written and read by human programmers or the compiler. Using this structure enables you to interact with the source code on a deeply meaningful level. It's no longer text strings, but data that represents the structure of a C# program. +To get started, you'll need to install the **.NET Compiler Platform SDK**: + +[!INCLUDE[interactive-note](~/includes/roslyn-installation.md)] + ## Understanding syntax trees You use the Syntax API for any analysis of the structure of C# code. The **Syntax API** exposes the parsers, the syntax trees, and utilities for analyzing and constructing syntax trees. It's how you search code for specific syntax elements or read the code for a program. @@ -64,9 +68,6 @@ While you can find anything in a code file using the Syntax APIs, most scenarios You can examine the nodes in a syntax tree in two ways. You can traverse the tree to examine each node, or you can query for specific elements or nodes. -> [!IMPORTANT] -> The following samples require the **.NET Compiler Platform SDK** installed as part of Visual Studio 2017. You can find the .NET Compiler SDK as the last optional component listed under the **Visual Studio extension development** workload. The templates aren't installed without this component. - ### Manual traversal You can see the finished code for this sample in [our GitHub repository](https://github.com/dotnet/docs/tree/master/samples/csharp/roslyn-sdk/SyntaxQuickStart). diff --git a/docs/csharp/roslyn-sdk/index.md b/docs/csharp/roslyn-sdk/index.md index 2c6d3b06a021b..194193de6b032 100644 --- a/docs/csharp/roslyn-sdk/index.md +++ b/docs/csharp/roslyn-sdk/index.md @@ -130,10 +130,15 @@ found in the quickstarts, samples and tutorials sections. You can learn more about the concepts in the .NET Compiler Platform SDK in these four topics: + - [Explore code with the syntax visualizer](syntax-visualizer.md) - [Understand the compiler API model](compiler-api-model.md) - [Work with syntax](work-with-syntax.md) - [Work with semantics](work-with-semantics.md) - [Work with a workspace](work-with-workspace.md) + +To get started, you'll need to install the **.NET Compiler Platform SDK**: + +[!INCLUDE[interactive-note](~/includes/roslyn-installation.md)]