Bug 11327 - Feature Request - Hover Help Improvement - XML Documentation comments
Summary: Feature Request - Hover Help Improvement - XML Documentation comments
Status: CONFIRMED
Alias: None
Product: Xamarin Studio
Classification: Desktop
Component: Text Editor ()
Version: 4.0.2
Hardware: Macintosh Mac OS
: Normal enhancement
Target Milestone: Future Cycle (TBD)
Assignee: Vaclav Vancura
URL:
Depends on:
Blocks:
 
Reported: 2013-03-21 14:50 UTC by Joseph Remes
Modified: 2017-07-21 00:34 UTC (History)
4 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report for Bug 11327 on Developer Community or GitHub if you have new information to add and do not yet see a matching new report.

If the latest results still closely match this report, you can use the original description:

  • Export the original title and description: Developer Community HTML or GitHub Markdown
  • Copy the title and description into the new report. Adjust them to be up-to-date if needed.
  • Add your new information.

In special cases on GitHub you might also want the comments: GitHub Markdown with public comments

Related Links:
Status:
CONFIRMED

Description Joseph Remes 2013-03-21 14:50:51 UTC
I notice that when I add XML Documentation comments to a function, the hover help shows part of them when the function is referenced. However. Bit it seems that only the <summary> element is displayed. I would like to also see the <param, <returns, and <exception comments. And any others you can think of.

Also, isn't it about time that Xamarin Studio appeared in the product dropdown above? And the editor I am talking about is known as 'Source Code Editor' inside the studio. I picked Text Editor because it seemed the closest among the options.
Comment 1 Mike Krüger 2013-03-22 03:37:50 UTC
@david: It's a bit difficult since the documentation can be very complex + the tooltips are no html control - the documentation requires some text layouting as well.
Comment 2 Marius Ungureanu 2016-11-03 10:16:07 UTC
CC-ing vaclav for additional thoughts on this issue.
Comment 3 Jon Goldberger [MSFT] 2017-07-21 00:34:59 UTC
Thanks so much for taking the time to submit this report! I can confirm using the latest Visual Studio 2017 for Mac Preview version 7.1 I am able to reproduce this issue. Marking this report as CONFIRMED.