Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SA1009 can trigger when a closing parenthesis ends XML comment's cref attribute #2985

Closed
peteroupc opened this issue Jul 23, 2019 · 2 comments · Fixed by #3497
Closed

SA1009 can trigger when a closing parenthesis ends XML comment's cref attribute #2985

peteroupc opened this issue Jul 23, 2019 · 2 comments · Fixed by #3497

Comments

@peteroupc
Copy link

peteroupc commented Jul 23, 2019

SA1009 can trigger (and output the message "Closing parenthesis should be followed by a space") when a closing parenthesis ends a cref attribute in XML documentation, as in the following example:

/// <summary>This is a test.  
/// <see cref='MyClass.MyMethod(System.String)'/></summary>

In general, SA1009 should not apply to closing parentheses in comments at all.

@sharwell
Copy link
Member

This started occurring with #1840. The bug occurs for the specific case of single quoted XML attributes.

@sharwell
Copy link
Member

📝 The analysis of parentheses in cref attributes is intentional, as mentioned in #1834 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants