Standard: Add intellisense files into NETStandard.Library package

Created on 17 Dec 2016 · 16Comments · Source: dotnet/standard

@terrajobst @mairaw any thoughts on how we get the intellisense files for netstandard.dll?

packaging

Source

weshaggard

Most helpful comment

Is this holding back 2.0 from being released? whats the status on this??

sjk07 on 23 Jun 2017

👍3

All 16 comments

That's a good one.

I'd say that depends on how we want to generate the reference documentation in the first place. My naiive view is that we should simply choose a concrete platform (let's say .NET Framework or .NET Core) as the starting point and generate the master file for .NET Standard. From then on, the documentation is provided when we add APIs, using the docs that already exist for the given APIs.

terrajobst on 17 Dec 2016

Can you educate me on how this is going to work? I always thought that the .NET Standard was just a spec but that the real implementation would come from each individual platform. So what implementation will you have on this DLL? Or does it only contain the API signatures?

We could probably add that DLL to our reflection process that would identify the platform as .NET Standard. We're still designing the solution.

/cc @dend @bradygaster

mairaw on 17 Dec 2016

@mairaw I would guess he is talking about https://www.nuget.org/packages/NETStandard.Library/ which seems to provide netstandard1.6 for platforms only supporting netstandard1.0-1.3.
This should work since according to documentation the netstandard is also provided by packages and not only by the platform. (https://docs.microsoft.com/en-us/dotnet/articles/core/packages#package-based-frameworks) At least that is how I understood it, or am I mistaken?

Qowy on 18 Dec 2016

.NET Standard is sort of an API spec but it will also be a targeting pack for libraries that want to build only against .NET Standard. So we will have the NETStandard.Library package which will contain a set of reference assemblies for people that want to build libraries against the standard.

weshaggard on 19 Dec 2016

[@mairaw] an you educate me on how this is going to work?

What @weshaggard is talking about here is having an XML file called netstandard.xml that contains the tripple-slash documentation that IntelliSense will show when authoring libraries targeting .NET Standard.

I was suggesting generating this file from the reference documentation we already have for .NET Framework/.NET Core.

terrajobst on 19 Dec 2016

I was suggesting generating this file from the reference documentation we already have for .NET Framework/.NET Core.

That should be possible with the new tooling we're developing. If not, we should add that as a requirement.

/cc @bradygaster @dend

mairaw on 21 Dec 2016

👍1

@mairaw how would be the right person to assign this work item to to get the intellisense file generated?

weshaggard on 16 Feb 2017

I think @dend would be the right person for now. @dend can you confirm? Once we have the tooling ready, then I can be the point of contact to provide the IntelliSense files.

mairaw on 16 Feb 2017

I don't think this is ready for me yet.

We need a netstandard.xml produced first. That's the only thing with type-defs in this repo. I don't have one, so I can't add it to the package. @terrajobst / @mairaw can you please identify an appropriate owner on the doc team to produce this?