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
My team almost always adds XML comments for public classes and enums but rarely for public methods or properties. Therefore, I'd like a more fine-grained control over CS1591. Namely, it'd be great if there's something like csharp_add_xml_comment_for_publicly_visible_type_or_member=class,enum, which would trigger CS1591 for classes and enums but not for methods or properties. Is this feasible? (Maybe not if the .editorconfig value can only be a single value...)
Languages applicable
C# only
Code example that the analyzer should report
C# file:
namespace MyNamespace;publicenumMyEnum// flagged{One,Two,}publicclassMyClass// flagged{publicintMyProperty=>1;// not flaggedpublicvoidMyMethod()=>thrownew NotImplementedException();// not flagged}
Brief description
I'd like to request a small enhancement to CS1591 Missing XML comment for publicly visible type or member 'Type_or_Member'.
My team almost always adds XML comments for public classes and enums but rarely for public methods or properties. Therefore, I'd like a more fine-grained control over CS1591. Namely, it'd be great if there's something like
csharp_add_xml_comment_for_publicly_visible_type_or_member=class,enum
, which would trigger CS1591 for classes and enums but not for methods or properties. Is this feasible? (Maybe not if the.editorconfig
value can only be a single value...)Languages applicable
C# only
Code example that the analyzer should report
C# file:
.editorconfig
:The text was updated successfully, but these errors were encountered: