dotnet / dotnet/fsharp

XML documentation in Visual Studio 2017

Open
#3,213 5 comments 1 reaction 1 assignee Claimed by @abelbraaksma View on GitHub
Area-LangService-ToolTips Feature Improvement
Dominant language
F#
Stars
4.3k
Forks
876
Avg merge
4d 11h
Merged PRs (30d)
131

Description

I would like to add a multi-line XML documentation that will appear in the Intelli-Sense bubble when my mouse hover over it. Please see the following post:

https://stackoverflow.com/questions/44565660/f-xml-multiline-documentation-visual-studio-2017

#### Repro steps

1. Use Visual Studio 2017.

2. Type the following code, and hover your mouse over it.

![](https://i.stack.imgur.com/sQuA2.png)

#### Expected behavior

In Visual Studio 2015, the following code works.

![](https://i.stack.imgur.com/3Ozjc.png)

#### Actual behavior

In Visual Studio 2017, the following code does not work.

![](https://i.stack.imgur.com/KT99p.png)

#### Known workarounds

According to stack overflow answers, the following code works for getting double-spacing. Is single spacing no longer supported?

![partial solution](https://user-images.githubusercontent.com/29471423/27208470-6d2e36e8-5278-11e7-8a3c-9d64946bb721.png)

Thank you very much for your help.

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.