Skip to content

Mute RCS1253 (summary on one line) when not applicable? #1627

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

Open
jafaber opened this issue Feb 16, 2025 · 1 comment
Open

Mute RCS1253 (summary on one line) when not applicable? #1627

jafaber opened this issue Feb 16, 2025 · 1 comment

Comments

@jafaber
Copy link

jafaber commented Feb 16, 2025

Having the preference for

configured to single line using:

roslynator_doc_comment_summary_style = single_line

Can RCS1253 be muted when the summary is longer than N characters and/or when the <summary> contains one of <para>, <list>, <br> (or possibly some others) ?

@josefpihrt
Copy link
Collaborator

Hi,

I'd split this issue into two parts:

  • Do not suggest to convert multiline comment into singleline when a comment contains <para> etc.
    • this is basically a bug and should be fixed
  • Do not suggest to convert multiline comment into singleline when a comment text is longer than x characters
    • this could be accomplished by providing some kind of an options like roslynator_doc_comment_single_line_summary_max_length and probably should work both ways, i.e. multi to single and single to multi based on comment length.

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

No branches or pull requests

2 participants