dotnet / dotnet/fsharp

F# triple-slash /// comment tags shown **without line breaks** in tooltip

Open
#15,851 4 comments 0 reactions 0 assignees View on GitHub
Area-VS-Editor Feature Improvement
Dominant language
F#
Stars
4.3k
Forks
876
Avg merge
4d 22h
Merged PRs (30d)
144

Description

_This issue has been moved from [a ticket on Developer Community](https://developercommunity.visualstudio.com/t/F-triple-slash--comment-tags-not-wor/10438780)._

---
[severity:It's more difficult to complete my work]
Here is an example:
```
/// Processes one TextBox
/// The name of the TextBox.
/// The name of the TextBox.
/// unit
let procOne ((txtBxName: string), (txt: string)): unit =
```

In Visual Studio, when I hover the mouse over **procOne**, Everything is run together into one line.

`curliness |> List.iter procOne`

Here is the documentation I see on the Microsoft website:

[https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/xml-documentation]()

The documentation specifies the behavior of the XAML tags.

None of the tags seems to work.
gives no advantage over no-tag comment. It does not put any line breaks anywhere.

Visual Studio does validate the comment with tags and points out errors correctly as far as I can tell. However, my complaint is that there is no way to format the documentation so that the tool-tip is readable.

What I would like is to leave the tags as they are, not working in Visual Studio. But when you use triple-comments without any tags, then there should be a linebreak in the tool-tip at the end of each line.

For example,

```
/// Processes one TextBox
/// txtBxName = The name of the TextBox.
/// txt = The name of the TextBox.
/// Returns unit.
```

Should display like this in the tool-tip:

> Processes one TextBox
> txtBxName = The name of the TextBox.
> txt = The name of the TextBox.
> Returns unit.

and not like this:

> Processes one TextBox txtBxName = The name of the TextBox.txt = The name of the TextBox. Returns unit.

---
### Original Comments

#### Feedback Bot on 8/14/2023, 04:27 AM:

(private comment, text removed)
#### Vlad Zarytovskii [MSFT] on 8/24/2023, 02:02 PM:

(private comment, text removed)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.