You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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
The text was updated successfully, but these errors were encountered:
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 produceWe don't resolve
cref
nodes in the compiler. This means F# code hasbut 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
The text was updated successfully, but these errors were encountered: