From @breyed on Fri, 11 Oct 2019 16:00:20 GMT
Summary
A legal disclaimer apparently designed for the web is leaking into IntelliSense and adding friction to the development experience. IntelliSense should be streamlined to show only useful information, so that developers aren't wasting time with clicks that turn out to be pointless or reading info that turns out to be unhelpful.
Repro
- In an Android project, stick this code somewhere:
var uc = PendingIntentFlags.UpdateCurrent;.
- Click
UpdateCurrent and press F12 (Go To Definition).
- Notice that the full enum definition for
PendingIntentFlags shows up with UpdateCurrent highlighted. Awesome!
- Notice that each field has "..." expansion buttons. More awesome! I can click on any one I wish to get more info about that field.
- Double-click on the "..." for
UpdateCurrent.
- Feel the sense of utter disappointment:
Both the summary are remarks section are worse than useless. They provide no help whatsoever and wasted my time even clicking the "...". It would have been better if there was no summary and remarks were absent. There would have been no "...", so I would have immediately known to turn to Google.
It's OK to not have docs for everything; I'm sure the Xamarin team doesn't have time to automate pulling in the docs for everything. But don't include fluffery. It's already obvious that if there are no docs, they are intended to be added later. And the legal disclaimer doesn't belong in IntelliSense; put that where the rest of the copyright info goes, such as with the NuGet package.
Copied from original issue xamarin/XamarinVS#11094
From @breyed on Fri, 11 Oct 2019 16:00:20 GMT
Summary
A legal disclaimer apparently designed for the web is leaking into IntelliSense and adding friction to the development experience. IntelliSense should be streamlined to show only useful information, so that developers aren't wasting time with clicks that turn out to be pointless or reading info that turns out to be unhelpful.
Repro
var uc = PendingIntentFlags.UpdateCurrent;.UpdateCurrentand press F12 (Go To Definition).PendingIntentFlagsshows up withUpdateCurrenthighlighted. Awesome!UpdateCurrent.Both the summary are remarks section are worse than useless. They provide no help whatsoever and wasted my time even clicking the "...". It would have been better if there was no summary and remarks were absent. There would have been no "...", so I would have immediately known to turn to Google.
It's OK to not have docs for everything; I'm sure the Xamarin team doesn't have time to automate pulling in the docs for everything. But don't include fluffery. It's already obvious that if there are no docs, they are intended to be added later. And the legal disclaimer doesn't belong in IntelliSense; put that where the rest of the copyright info goes, such as with the NuGet package.
Copied from original issue xamarin/XamarinVS#11094