Show <value> documentation in Metadata as Source and Object Browser#36491
Merged
sharwell merged 3 commits intodotnet:masterfrom Feb 6, 2020
Merged
Show <value> documentation in Metadata as Source and Object Browser#36491sharwell merged 3 commits intodotnet:masterfrom
sharwell merged 3 commits intodotnet:masterfrom
Conversation
JoeRobich
reviewed
Sep 19, 2019
|
|
||
| list.VerifyImmediateMemberDescriptions( | ||
| "public int M { get; }" & vbCrLf & | ||
| $" {String.Format(ServicesVSResources.Member_of_0, "C")}" & vbCrLf & |
Member
There was a problem hiding this comment.
Should we have a test helper for building the description string so that the formatting logic is in a single place instead of in each test? something like
string BuildDescription(string declaration, string containingMemberName = null, string summaryText = null, string returnText = null, string valueText = null)
Contributor
Author
There was a problem hiding this comment.
We could, but it seems out of scope for this pull request
| emittedDocs = true; | ||
| } | ||
|
|
||
| if (ShowValueDocumentation(symbol) && documentationComment.ValueText != null) |
Member
There was a problem hiding this comment.
Is it possible to include both a returns and value in the doc comments?
Contributor
Author
There was a problem hiding this comment.
Yes, it's possible, though it typically does not make sense to do so (not recommended to use both).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
<value>documentation in Metadata as Source<value>documentation in Object BrowserThis establishes the initial data flow and first features as a prerequisite for #31618 and #8627.