`///` comments on the same line as a DU case apply to the next case

[michaelwinch]

If you add a triple slash comment /// on the same line after a DU case, it will add the information to the next case.
Edit: I've just also noticed this happens on records too

Repro steps

Expected behavior

I would expect it to either add it to the case that it's on the same line as, or ignore it completely

Actual behavior

It adds the comment to the case after

Known workarounds

Move it to it's own line before the case

Related information

This happens on Rider and VSCode (latest)
.NET 8

[T-Gro]

Thanks for this report.
I wonder what the corrective action should be.

Triple-slash comments are meant to go above a definiton.

Should the language parser in this case turn the /// doc comment into a regular // comment, not affecting the generated documentation string?

Or make an exception in the language, and design/allow "inline" triple slash comments which go next to the definition? (let's say limited to same line only, never below)

[edgarfgp]

It is even worst when using /// in different places like

type Shape =
    /// Im a rectangle
    | Rectangle of width : float * length : float /// Im sill a rectangle
    /// Im a circle
    | Circle of radius : float /// Im a still circle
    /// Im a prism
    | Prism of width : float * float * height : float /// Im a still prism

Related suggestion fsharp/fslang-suggestions#948

[T-Gro]

That approved suggestion makes a lot of sense, the limitations should be indeed lifted 👍

[edgarfgp]

That approved suggestion makes a lot of sense, the limitations should be indeed lifted 👍

@baronfel Has a prototype for the linked suggestion main...baronfel:union-case-field-xmldoc :)

[auduchinok]

I wonder what the corrective action should be.

I would issue a warning for a /// comment when it's not the first thing on a line.

I think being uniform with the most of the popular languages is important here. I don't think being able to place a comment in a non-standard place outweigh the costs of updating all the tooling for the language and going against the people expectations.