RCS1253: Format documentation comment summary
Properties
| Property | Value |
|---|---|
| Default Severity | disabled by default |
| Minimum language version | - |
Summary
This analyzer replaces RCS1100 and RCS1101.
Examples
Example #1
.editorconfig
roslynator_doc_comment_summary_style = multi_line
diagnostic.cs
/// <summary>Represents a foo.</summary>
class Foo
{
}
fix.cs
/// <summary>
/// Represents a foo.
/// </summary>
class Foo
{
}
Example #2
.editorconfig
roslynator_doc_comment_summary_style = single_line
diagnostic.cs
/// <summary>
/// Represents a foo.
/// </summary>
class Foo
{
}
fix.cs
/// <summary>Represents a foo.</summary>
class Foo
{
}
Configuration
info
Option roslynator_doc_comment_summary_style is required to be set for this analyzer to work.
.editorconfig
# Format documentation comment summary on single line or multiple lines
roslynator_doc_comment_summary_style = multi_line|single_line