You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Product and Version Used:
VS extension Roslynator 2022 v4.12.5
Steps to Reproduce:
Enable RCS1181 in your .editorconfig file (disabled by default).
Make sure the containing project is configured to generate documentation files:
Open project Properties.
Go to page Build -> Output
Generate a file containing API documentation
Open a C# file and add a comment after the namespace.
Actual Behavior:
namespaceMyNamespace// Some comment. <-- RCS1181: Convert comment to documentation comment{/// <summary>/// .../// </summary>publicclassClass1{internalintMyProperty{get;set;}}}
which is wrong, because applying the code fix produces code that triggers a compiler error:
/// <summary> <-- CS1587: XML comment is not placed on a valid language element/// Some comment./// </summary>namespaceMyNamespace{/// <summary>/// .../// </summary>publicclassClass1{internalintMyProperty{get;set;}}}
Expected Behavior:
namespaceMyNamespace// Comment. <-- No RCS1181{/// <summary>/// .../// </summary>publicclassClass1{internalintMyProperty{get;set;}}}
You can't add documentation comments to a namespace (see first table here).
Bottom line: RCS1181 should never be reported for comments on namespaces.
The text was updated successfully, but these errors were encountered:
Product and Version Used:
VS extension Roslynator 2022 v4.12.5
Steps to Reproduce:
RCS1181
in your.editorconfig
file (disabled by default).Actual Behavior:
which is wrong, because applying the code fix produces code that triggers a compiler error:
Expected Behavior:
You can't add documentation comments to a namespace (see first table here).
Bottom line:
RCS1181
should never be reported for comments on namespaces.The text was updated successfully, but these errors were encountered: