-
Notifications
You must be signed in to change notification settings - Fork 5.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial documentation for additional tools #3871
Conversation
@@ -0,0 +1,51 @@ | |||
## Microsoft WCF Web Service Reference Provider | |||
|
|||
Over the years, many Visual Studio developers have enjoyed the productivity that Add Service Reference provides when their .NET Framework projects needed to access Windows Communication Foundation (WCF) services. The WCF team is excited to introduce the WCF Connected Service for .NET Core and ASP.NET Core, a VS extension providing an experience like the Add Service Reference functionality. This tool retrieves metadata from a WCF service in the current solution, locally or on a network, and generates a .NET Core compatible source code file for a WCF client proxy that you can use to access the service. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... that Add Service Reference provides when their .NET Framework projects needed to ...
It seems to me that either provides
should be provided
or needed
should be need
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This tool retrieves metadata from a WCF service in the current solution, locally or on a network...
This sentence doesn't sound right.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, maybe something like "This tool retrieves metadata from a WCF service in the current solution, a WSDL file at the local disk or a web service on a network...".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed the 'locally' part, the rest is OK.
|
||
### How to use the extension | ||
|
||
The WCF Web Service Reference VS connected service extension is applicable to projects created using the templates under Visual C# -> .Net Core, Visual C# -> .Net Standard and Visual C# -> Web -> ASP.NET CORE Web Application projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Visual C# -> .Net Standard and Visual C#
Add a ,
before and
, e.g.,
Visual C# -> .Net Standard, and Visual C#
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ASP.NET CORE
should be ASP.NET Core
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed the 'CORE' part, the rest is OK - thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and .NET is spelled all caps
|
||
Over the years, many Visual Studio developers have enjoyed the productivity that the [Add Service Reference](https://msdn.microsoft.com/en-us/library/bb386382.aspx) tool provided when their .NET Framework projects needed to access Windows Communication Foundation (WCF) services. The WCF team is excited to introduce the **WCF Web Service Reference** tool, a Visual Studio connected service extension providing an experience like the Add Service Reference functionality for .NET Core and ASP.NET Core projects. This tool retrieves metadata from a WCF service in the current solution, from a WSDL file or on a network location, and generates a .NET Core compatible source file containing WCF client proxy code that you can use to access the web service. | ||
|
||
> [!!IMPORTANT] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two !s may mean it's very important but not sure if it will work ;-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @mlacouture! Finally managed to sit down and review this. Let us know if we can help with the edits.
docs/core/additional-tools/index.md
Outdated
@@ -0,0 +1,19 @@ | |||
--- | |||
title: .NET Core Additional Tools |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use sentence case for title and headings. So it should be .NET Core additional tools
docs/core/additional-tools/index.md
Outdated
@@ -0,0 +1,19 @@ | |||
--- | |||
title: .NET Core Additional Tools | |||
description: An overview of the additional tools that support and extend .Net Core functionality. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
here and in other places on this PR: .NET needs to be all capital
docs/core/additional-tools/index.md
Outdated
--- | ||
title: .NET Core Additional Tools | ||
description: An overview of the additional tools that support and extend .Net Core functionality. | ||
author: miguell |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
your GH alias is mlacouture, so you should this here
docs/core/additional-tools/index.md
Outdated
title: .NET Core Additional Tools | ||
description: An overview of the additional tools that support and extend .Net Core functionality. | ||
author: miguell | ||
ms.author: miguell |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
put mairaw here so I'm responsible for keeping up with feedback, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you want me to change this to johalex instead?
docs/core/additional-tools/index.md
Outdated
ms.date: 12/04/2017 | ||
ms.topic: article | ||
ms.prod: .net-core | ||
ms.technology: .net-core tools. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this line. we don't have a specific entry on our BI reports for this yet, so let's keep it blank for now
``` | ||
dotnet new console --name MyApp | ||
``` | ||
1. Edit the .csproj and add a reference to the Microsoft.XmlSerializer.Generator package. For example, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
choose one way of doing it. since you're already on CLI, continue to use the CLI.
You can then tell them they can open the project file and see that the following lines were added.
Something like:
- Add a reference to the Microsoft.XmlSerializer.Generator package:
dotnet add package Microsoft.XmlSerializer.Generator -v 1.0.0-preview1-25915-02
After running the command, the following lines are added to your project file:
<ItemGroup>
<DotNetCliToolReference Include="Microsoft.XmlSerializer.Generator" Version="1.0.0-preview1-25915-02" />
</ItemGroup>
public int Value; | ||
} | ||
``` | ||
Now you can create an `XmlSerializer` for MyClass. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
end with :
```c# | ||
var serializer = new System.Xml.Serialization.XmlSerializer(typeof(MyClass)); | ||
``` | ||
1. Build the application by running `dotnet build`. If everything succeeds, an assembly named MyApp.XmlSerializers.dll will be generated in the output folder. You will see warnings in the build output if the tool failed to generate the assembly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
everything -> build
will be -> is
remove last sentence
``` | ||
1. Build the application by running `dotnet build`. If everything succeeds, an assembly named MyApp.XmlSerializers.dll will be generated in the output folder. You will see warnings in the build output if the tool failed to generate the assembly. | ||
|
||
Start the application and it will automatically load and use the pre-generated serializers at runtime. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how do you start the application?
it will automatically load and use -> It automatically loads and uses
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Start the application by running dotnet run
from the project folder ..
docs/toc.md
Outdated
@@ -114,6 +114,7 @@ | |||
## [Runtime IDentifier catalog](core/rid-catalog.md) | |||
## [.NET Core SDK Overview](core/sdk.md) | |||
## [.NET Core CLI Tools](core/tools/index.md) | |||
## [.NET Core Additional Tools](core/additional-tools/index.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should be moved to line 149 before the Porting from .NET Framework entry
the other two new topics should be under this toc entry with the ###
docs/core/additional-tools/index.md
Outdated
ms.technology: .net-core tools. | ||
--- | ||
# .NET Core additional tools | ||
This section compiles a list of tools that support and extend the .Net Core functionality, in addition to the [.NET Core command-line interface (CLI)](..\tools\index.md) tools. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.Net should be .NET
docs/core/additional-tools/index.md
Outdated
|
||
|
||
### [WCF Web Service Reference](wcf_web_service_reference-guide.md) | ||
The WCF Web Service Reference is a Visual Studio connected service provider which made its debut in [Visual Studio 2017 version 15.5](https://www.visualstudio.com/en-us/news/releasenotes/vs2017-relnotes#WCFTools). Similarly to the Add Service Reference tool for classic .Net Framework VS projects, it allows for generating a web service reference containing proxy code that makes it easier for a client to consume the web service's functionality. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.Net should be .NET
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might revise with something like: "The WCF Web Service Reference Tool generates a web service reference containing proxy code for a client to easily consume the web service's functionality, similar to the Add Service Reference tool for classic .NET Framework VS project."
docs/core/additional-tools/index.md
Outdated
This section compiles a list of tools that support and extend the .Net Core functionality, in addition to the [.NET Core command-line interface (CLI)](..\tools\index.md) tools. | ||
|
||
|
||
### [WCF Web Service Reference](wcf_web_service_reference-guide.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should Tool be included?
Added the recommended changes from the reviewers for this file.
Update based on review feedback and rename wcf_web_service_reference-guide.md to wcf-web-service-reference-guide.md
Update based on review feedback and format tutorial
docs/core/additional-tools/index.md
Outdated
The WCF Web Service Reference is a Visual Studio connected service provider that made its debut in [Visual Studio 2017 version 15.5](https://www.visualstudio.com/en-us/news/releasenotes/vs2017-relnotes#WCFTools). The WCF Web Service Reference Tool generates a web service reference containing proxy code for a client to easily consume the web service's functionality, similar to the Add Service Reference tool for .NET Framework Visual Studio projects. | ||
|
||
### [XML Serializer Generator](xmlserializergenerator-instructions.md) | ||
Like the [Xml Serializer Generator (sgen.exe)](https://docs.microsoft.com/en-us/dotnet/standard/serialization/xml-serializer-generator-tool-sgen-exe) for .NET Framework, <xref:System.Xml.Serialization.XmlSerializer> NuGet package is the solution for .NET Core and .NET Standard Libraries. It creates an XML serialization assembly for types contained in an assembly to improve the startup performance of XML serialization when serializing or de-serializing objects of those types using XmlSerializer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
System.Xml.Serialization.XmlSerializer
is not a package, it's a class.
The article talks about the Microsoft.XmlSerializer.Generator package, is that what should be mentioned here? (And I think you can't have an xref to a package.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, good catch.
docs/core/additional-tools/index.md
Outdated
# .NET Core additional tools | ||
This section compiles a list of tools that support and extend the .NET Core functionality, in addition to the [.NET Core command-line interface (CLI)](..\tools\index.md) tools. | ||
|
||
### [WCF Web Service Reference Tool](wcf_web_service_reference-guide.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this link correct? The link is to wcf_web_service_reference-guide.md
, but the actual file name is wcf-web-service-reference-guide.md
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The file has been renamed since the link was added.
> The **WCF Web Service Reference** option is applicable to projects created using the following project templates: | ||
* **Visual C#** > **.NET Core**, | ||
* **Visual C#** > **.NET Standard** | ||
* **Visual C#** > **Web** > **ASP.NET Core Web Application** . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the formatting here is incorrect: the list will be formatted outside the note. To make it show inside, the items in the list should also start with a >
:
> [!NOTE]
> The **WCF Web Service Reference** option is applicable to projects created using the following project templates:
> * **Visual C#** > **.NET Core**,
> * **Visual C#** > **.NET Standard**,
> * **Visual C#** > **Web** > **ASP.NET Core Web Application** .
Also, the items should either form a sentence (which means adding a comma to the second item) or not (which means removing the comma from the first item and removing the period from the third item).
* **Visual C#** > **.NET Standard** | ||
* **Visual C#** > **Web** > **ASP.NET Core Web Application** . | ||
|
||
Using the **ASP.NET Core Web Application** project template as an example, This article walks you through adding a WCF service reference to the project: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This -> this
4. The **Data Type Options** form enables you to refine the generated service reference configuration settings. | ||
|
||
> [!NOTE] | ||
> The**Reuse types in referenced assemblies** check box option is useful when data types needed for service reference code generation are defined in one of your project's referenced assemblies. It's important to reuse those existing data types to avoid compile-time type clash or runtime issues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing space before **Reuse
.
public class MyClass | ||
{ | ||
public int Value; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: the code looks weird with the braces indented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indents are gone.
|
||
### Build and run the application | ||
|
||
Still within the *myApp* folder, run the application via [`dotnet run`](../tools/dotnet-run.md) and it will automatically load and use the pre-generated serializers at runtime. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: myApp -> MyApp
|
||
If everything succeeds, an assembly named *MyApp.XmlSerializers.dll* is generated in the output folder. | ||
|
||
Congratulations! you have just: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you -> You
|
||
Congratulations! you have just: | ||
> [!div class="checklist"] | ||
> * Create a .NET Core app. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Create -> Created
> * Added a reference to the Microsoft.XmlSerializer.Generator package | ||
> * Edited your MyApp.csproj to add dependencies. | ||
> * Added a class and an XmlSerializer | ||
> * Built and ran the application |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of the list items are missing a period.
* Updated Note formatting * Fixed capitalization * added space before **Reuse * Update the project file moved to new line
Removed the words "nuget package" from the introduction paragraph.
Corrected and asdded needed entries for TOC
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's coming together nicely. A few extra comments 😃
docs/toc.md
Outdated
@@ -146,6 +146,9 @@ | |||
##### [dotnet add package](core/tools/dotnet-add-package.md) | |||
##### [dotnet remove package](core/tools/dotnet-remove-package.md) | |||
### [global.json](core/tools/global-json.md) | |||
## [.NET Core Additional Tools](core/additional-tools/index.md) | |||
### [Microsoft WCF Web Service Reference Provider Tool](core/additional-tools/wcf-web-service-reference-guide.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: I'd probably cut Microsoft and Tool from the TOC
docs/toc.md
Outdated
@@ -146,6 +146,9 @@ | |||
##### [dotnet add package](core/tools/dotnet-add-package.md) | |||
##### [dotnet remove package](core/tools/dotnet-remove-package.md) | |||
### [global.json](core/tools/global-json.md) | |||
## [.NET Core Additional Tools](core/additional-tools/index.md) | |||
### [Microsoft WCF Web Service Reference Provider Tool](core/additional-tools/wcf-web-service-reference-guide.md) | |||
### [Using Microsoft XML Serializer Generator on .NET Core](core/additional-tools/xmlserializergenerator-instructions.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: I'd cut Using Microsoft and on .NET Core from the TOC
--- | ||
# Microsoft WCF Web Service Reference Provider Tool | ||
|
||
Over the years, many Visual Studio developers have enjoyed the productivity that the [Add Service Reference](https://docs.microsoft.com/en-us/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference) tool provided when their .NET Framework projects needed to access Windows Communication Foundation (WCF) services. The **WCF Web Service Reference** tool is a Visual Studio connected service extension that provides an experience like the Add Service Reference functionality for .NET Core and ASP.NET Core projects. This tool retrieves metadata from a WCF service in the current solution, from a WSDL file or on a network location, and generates a .NET Core compatible source file containing WCF client proxy code that you can use to access the web service. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: bold the second Add Service Reference since it's an UI option
remove https://docs.microsoft.com/en-us from the link
docs/core/additional-tools/index.md
Outdated
The WCF Web Service Reference is a Visual Studio connected service provider that made its debut in [Visual Studio 2017 version 15.5](https://www.visualstudio.com/en-us/news/releasenotes/vs2017-relnotes#WCFTools). The WCF Web Service Reference Tool generates a web service reference containing proxy code for a client to easily consume the web service's functionality, similar to the Add Service Reference tool for .NET Framework Visual Studio projects. | ||
|
||
### [XML Serializer Generator](xmlserializergenerator-instructions.md) | ||
Like the [Xml Serializer Generator (sgen.exe)](https://docs.microsoft.com/en-us/dotnet/standard/serialization/xml-serializer-generator-tool-sgen-exe) for .NET Framework, <xref:System.Xml.Serialization.XmlSerializer> is the solution for .NET Core and .NET Standard Libraries. It creates an XML serialization assembly for types contained in an assembly to improve the startup performance of XML serialization when serializing or de-serializing objects of those types using XmlSerializer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
relative path instead of absolute URL here
Libraries -> libraries
XmlSerializer -> <xref:System.Xml.Serialization.XmlSerializer>
or inline quote
docs/core/additional-tools/index.md
Outdated
This section compiles a list of tools that support and extend the .NET Core functionality, in addition to the [.NET Core command-line interface (CLI)](..\tools\index.md) tools. | ||
|
||
### [WCF Web Service Reference Tool](wcf-web-service-reference-guide.md) | ||
The WCF Web Service Reference is a Visual Studio connected service provider that made its debut in [Visual Studio 2017 version 15.5](https://www.visualstudio.com/en-us/news/releasenotes/vs2017-relnotes#WCFTools). The WCF Web Service Reference Tool generates a web service reference containing proxy code for a client to easily consume the web service's functionality, similar to the Add Service Reference tool for .NET Framework Visual Studio projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove locale from url.
</ItemGroup> | ||
``` | ||
|
||
### Add another ItemGroup section for .NET Core CLI Tool support |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: funny that this header is not showing in blue
|
||
### Add another ItemGroup section for .NET Core CLI Tool support | ||
|
||
Add the following lines after the `ItemGroup` section that we just inspected. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
end with :
</ItemGroup> | ||
``` | ||
|
||
### Add a class in the application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
period in the heading?
* Install your favorite code editor, if you haven't already. | ||
|
||
> [!TIP] | ||
> Need to install a code editor? Try [Visual Studio](https://visualstudio.com/downloads)! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the link used by the vsdocs team is this one: https://aka.ms/vsdownload?utm_source=mscom&utm_campaign=msdocs
$ dotnet run | ||
``` | ||
> [!NOTE] | ||
> [`dotnet run`](../tools/dotnet-run.md) calls [`dotnet build`](../tools/dotnet-build.md) to ensure that the build targets have been built, and then calls `dotnet <assembly.dll>` to run the target application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure if we should add a note similar to what we have in the end of the following tutorial given that dotnet run is only meant for dev scenarios:
https://docs.microsoft.com/en-us/dotnet/core/tutorials/using-with-xplat-cli
"Note that the commands and steps shown in this tutorial to run your application are used during development time only. Once you're ready to deploy your app, you'll want to take a look at the different deployment strategies for .NET Core apps and the dotnet publish command."
updated description and progress window image
Resyncing changes
|
||
```csharp | ||
var serializer = new System.Xml.Serialization.XmlSerializer(typeof(MyClass)); | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just creating a serializer is not useful on its own.
Should this tutorial also include some short code that uses it? Or maybe link to another tutorial that explains that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. I linked to some other resources.
docs/core/additional-tools/index.md
Outdated
The WCF Web Service Reference is a Visual Studio connected service provider that made its debut in [Visual Studio 2017 version 15.5](https://www.visualstudio.com/news/releasenotes/vs2017-relnotes#WCFTools). The WCF Web Service Reference Tool generates a web service reference containing proxy code for a client to easily consume the web service's functionality, similar to the Add Service Reference tool for .NET Framework Visual Studio projects. | ||
|
||
### [XML Serializer Generator](xmlserializergenerator-instructions.md) | ||
Like the [Xml Serializer Generator (sgen.exe)](../standard/serialization/xml-serializer-generator-tool-sgen-exe.md) for .NET Framework, <xref:System.Xml.Serialization.XmlSerializer> is the solution for .NET Core and .NET Standard libraries. It creates an XML serialization assembly for types contained in an assembly to improve the startup performance of XML serialization when serializing or de-serializing objects of those types using <xref:System.Xml.Serialization.XmlSerializer>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe I was unclear in my previous comment, I think this should say:
Like the Xml Serializer Generator (sgen.exe) for .NET Framework, the Microsoft.XmlSerializer.Generator NuGet package is the solution for .NET Core and .NET Standard libraries.
Since XmlSerializer
on its own does not create the serialization assembly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed.
|
||
2. On the **Connected Services** page, click **Microsoft WCF Web Service Reference Provider**. This brings up the **Configure WCF Web Service Reference** wizard: | ||
|
||
![Service Endpoint tab](,/media/wcf-web-service-reference-guide/WCFCS-ServiceEndpointPage.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comma at the start of the link should be a period.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch.
> * How to add a class and an XmlSerializer | ||
> * How to build and run the application | ||
|
||
Like the [Xml Serializer Generator (sgen.exe)](https://docs.microsoft.com/en-us/dotnet/standard/serialization/xml-serializer-generator-tool-sgen-exe) for the .NET Framework, <xref:System.Xml.Serialization.XmlSerializer> is the equivalent for .NET Core and .NET Standard projects. It creates an XML serialization assembly for types contained in an assembly to improve the startup performance of XML serialization when serializing or de-serializing objects of those types using <xref:System.Xml.Serialization.XmlSerializer>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly to my other comment, I think this should say:
Like the Xml Serializer Generator (sgen.exe) for the .NET Framework, Microsoft.XmlSerializer.Generator NuGet package is the equivalent for .NET Core and .NET Standard projects.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving this PR but there are still some comments left to be addressed.
@@ -0,0 +1,78 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove the hidden character here that is causing the metadata section not to render as a table on preview
docs/core/additional-tools/index.md
Outdated
The WCF Web Service Reference is a Visual Studio connected service provider that made its debut in [Visual Studio 2017 version 15.5](https://www.visualstudio.com/news/releasenotes/vs2017-relnotes#WCFTools). The WCF Web Service Reference Tool generates a web service reference containing proxy code for a client to easily consume the web service's functionality, similar to the Add Service Reference tool for .NET Framework Visual Studio projects. | ||
|
||
### [XML Serializer Generator](xmlserializergenerator-instructions.md) | ||
Like the [Xml Serializer Generator (sgen.exe)](../../standard/serialization/xml-serializer-generator-tool-sgen-exe.md) for .NET Framework, he Microsoft.XmlSerializer.Generator nuget package is the solution for .NET Core and .NET Standard libraries. It creates an XML serialization assembly for types contained in an assembly to improve the startup performance of XML serialization when serializing or de-serializing objects of those types using <xref:System.Xml.Serialization.XmlSerializer>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typically we'd say "for the .NET Framework" with the article
he -> the
nuget -> NuGet
inline code or create link for Microsoft.XmlSerializer.Generator?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I created a link to the NuGet package page.
--- | ||
# Microsoft WCF Web Service Reference Provider Tool | ||
|
||
Over the years, many Visual Studio developers have enjoyed the productivity that the [Add Service Reference](https://docs.microsoft.com/visualstudio/data-tools/how-to-add-update-or-remove-a-wcf-data-service-reference) tool provided when their .NET Framework projects needed to access web services. The **WCF Web Service Reference** tool is a Visual Studio connected service extension that provides an experience like the Add Service Reference functionality for .NET Core and ASP.NET Core projects. This tool retrieves metadata from a web service in the current solution, on a network location, or from a WSDL file, and generates a .NET Core compatible source file containing Windows Communication Foundation (WCF) client proxy code that you can use to access the web service. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove https://docs.microsoft.com from the link
bold Add Service Reference
|
||
The **Connected Services** page appears as shown in the following image: | ||
|
||
![Connected Services tab](./media/wcf-web-service-reference-guide/WCFCS-ConnectedServicesPage.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
images are not rendering. they are still not inside a media folder. also here the image name is still using capital letters, it should be lowercase.
also alt text should be more descriptive,
While displaying progress, the tool: | ||
|
||
* Downloads metadata from the WCF service. | ||
* Generates the service reference code in a file named *reference.cs*, and add it to your project under the **Connected Services** node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and add -> and adds
|
||
When these processes complete, you can create an instance of the generated WCF client type and invoke the service operations. | ||
|
||
## Next Steps |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sentence case in headings
var serializer = new System.Xml.Serialization.XmlSerializer(typeof(MyClass)); | ||
``` | ||
|
||
### Build and run the application |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should you show the whole file after all the steps are done so people can verify they did right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a dll.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JRAlexander I was talking about the source code above this step.
Title
Documentation for .net core additional tools.
Summary
This section is meant to compile information about tools in addition to CLI tools.
Internal Review URL(index.md)
Internal Review URL(wcf-web-service-reference-guide.md)
Internal Review URL(xml-serializer-generator.md)
Suggested Reviewers
@zhenlan