Show XML doc for enum fields in external metadata

[kerams]

devenv_k6dhCLFQ7n.mp4

It is displayed in tooltips, but not in the decompiled view.

Additional context

17.12.0 Preview 4.0

[vzarytovskii]

Yeah, we probably don't traverse or generate those when we generate decompiled view. Should be an easy fix (famous last words).

[ThobiWanKenobi]

I am interested in trying to accomplish this! Does anyone have any great tips for getting started with my first issue or where to start? I am about to read the developer guide and some of the compiler documentation.

[majocha]

Awesome! Hi, @ThobiWanKenobi, FSharpEntity.TryGetMetadataText() is the entry point in the service for this feature. I guess that's where the investigation starts.

As for the workflow, I'd add a small test case in FSharp.Compiler.Service.Tests.Symbols for this.

[ThobiWanKenobi]

Okay, I do have two questions. First of all, regarding the workflow. Lets say that I want to work on this, I am trying to set a breakpoint, and want to "activate" the line. What solution would I need to build, or what project would I need to run to be able to test this? And finally, I am experiencing a build issue, since the global.json file expects a .NET preview which is not yet publicly available from the downloads page (Specifically 10.0.100-preview.7.25322.101, but only 10.0.100-preview.6) is available for download , how do I handle that?

Thanks for the patience and helping me getting started!

[majocha]

Simple fix for the dotnet issue that works for me, assuming you're using Visual Studio:
Once you build from command line e.g. with Build.cmd -c Debug, you'll have a .dotnet folder in your repo root. Just copy its contents into C:\Program Files\dotnet. Visual Studio will see it then.

Working on this particular issue:

1. If you want to see it in action in actual IDE. You need to build VisualFSharp.sln in debug mode. Ctrl-T search for FSharpEntity.TryGetMetadataText and put a breakpoint there, then start debugging VisualFSharpDebug project. You'll see an experimental instance of VS, open some F# code and F12 on external symbol should activate your breakpoint.

2. Another, faster option is to write a test and debug it. You can use FSharp.Compiler.Service.sln for it. This is cross platform and should work in other IDEs.