11

If I use the <para></para> statement in a C# ///summary, I get a blank line and then the text goes on, which is equivalent to two line breaks (<br/> or \n).

However I'd really like to add single line breaks, which just cause my text to start at the next line, without leaving a blank line in between.

The suggested solutions don't work for me, see a screenshot: Two line breaks

Update: I'm using Visual Studio 2015 with Visual Assist Plugin, no manual changes done to any intelli-sense formatting options.

Update 2: It's not caused by the Visual Assist Plugin (I disabled it). It seems to be simply different in VS2015.

jmd42
  • 121
  • 1
  • 7
  • Is this question just on (auto) formatting XML Documetation Comments in your source, or adapt the output of the IntelliSense tooltip? –  Oct 09 '15 at 13:58
  • In intellisense there is no empty line between. – Tim Schmelter Oct 09 '15 at 14:00
  • @TimSchmelter hence I am asking ... –  Oct 09 '15 at 14:01
  • @TimSchmelter :) my bad ... sry –  Oct 09 '15 at 14:01
  • IntelliSense, I just added a screenshot. – jmd42 Oct 09 '15 at 14:12
  • @jmd42: [here's my screenshot](http://fs5.directupload.net/images/151009/l78cxg9t.png) (VS 2010, no Visual Assist Plugin): – Tim Schmelter Oct 09 '15 at 14:32
  • @TimSchmelter: Very interesting... I just disabled Visual Assist, and i still have double line breaks. Maybe it's just different on VS2015. – jmd42 Oct 09 '15 at 19:09
  • [Just a regular `
    ` works fine on my install of Visual Studio 2015. (Click for screenshot)](http://i.imgur.com/LVRDRCr.png)     – Joshua Shearer Oct 09 '15 at 19:24
  • 2
    @JoshuaShearer: Sadly it won't work for me,
    or
    just disappears and
    breaks the whole summary element, so that it is not shown anymore. Do I have to enable HTML support or something similar?     – jmd42 Oct 12 '15 at 14:47
  • @jmd42 I suppose it may work due to an extension on my installation. Perhaps ReSharper and/or GhostDoc alter the default functionality of my tooltips? I'd verify this, but all my machines have both these extensions installed. – Joshua Shearer Oct 12 '15 at 15:11
  • 2
    Possible duplicate of [Extra blank line displayed from and in VS2015CE, can't get rid of it](http://stackoverflow.com/questions/34598859/extra-blank-line-displayed-from-para-para-and-para-in-vs2015ce-cant-ge) – robert4 May 19 '16 at 17:56

1 Answers1

1

This is by the design of visual studio editor. If you are using Visual Studio's editor to view the summary, they have restricted it for limited html elements. You can still use most of the html elements to format your summary and will be applied when you export the documentation, but visual studio ignores them.

I think resharper intellisense formats the summary with

rAhulD
  • 59
  • 8