Skip to content
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

Possible improvements to XML doc processing in the compiler #9805

Open
dsyme opened this issue Jul 27, 2020 · 1 comment
Open

Possible improvements to XML doc processing in the compiler #9805

dsyme opened this issue Jul 27, 2020 · 1 comment
Labels
Area-XmlDocs xmldoc generation, xmldoc content Feature Request
Milestone

Comments

@dsyme
Copy link
Contributor

dsyme commented Jul 27, 2020

The intention for the F# compiler has always been that we would eventually process /// documentation in the same way as the C# compiler but with some additional small features, such as avoiding the need for /// <summary> </summary> tags.

I'm in the process of trialling the use of FSharp.Formatting fsdocs tool on FSharp.Core and noticing some problems with the CML we produce

  1. We don't resolve cref nodes in the compiler. This means F# code has

     /// <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception>
     /// <exception cref="System.ArgumentException">Thrown when the input sequence is empty.</exception>
    

    but the XML produced by C# would include the resolved symbol name e.g. T:System.ArgumentNullException. This means the XML produced by C# is really invalid according the the expected rules for XML doc files in .NET and will cause problems for other .NET tooling (e.g. C# projects looking at FSharp.Core).

I'll add more issues here as I find them

@MangelMaxime
Copy link

Hello,

I am looking at improving the TipFormatter from FSAC and came to report this problem.


I think you made a typo:

This means the XML produced by C#

should probably

This means the XML produced by F#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-XmlDocs xmldoc generation, xmldoc content Feature Request
Projects
Status: New
Development

No branches or pull requests

5 participants