Comments

Line comments

Line comment spacing

dress_line_comment_spacing = single

Controls comment-adjacent trivia. Comment text remains unchanged except for configured delimiter spacing.

• Values: none single
• Default: single
• Applies to: Comment-adjacent trivia.
• Guarantee: Comment text remains unchanged except for configured delimiter spacing.

Input

/// <summary>Formats this example.</summary>
class Example // attached comment
{
    /*block comment*/
}

single (Default)

Code unchanged.

none

/// <summary>Formats this example.</summary>
class Example // attached comment
class Example //attached comment
{
    /*block comment*/
}

Block comments

Block comment spacing

dress_block_comment_spacing = single

Controls comment-adjacent trivia. Comment text remains unchanged except for configured delimiter spacing.

• Values: none single
• Default: single
• Applies to: Comment-adjacent trivia.
• Guarantee: Comment text remains unchanged except for configured delimiter spacing.

Input

/// <summary>Formats this example.</summary>
class Example // attached comment
{
    /*block comment*/
}

single (Default)

/// <summary>Formats this example.</summary>
class Example // attached comment
{
    /*block comment*/
    /* block comment */
}

none

Code unchanged.

Attached comment placement

dress_attached_comment_placement = auto

Controls comment-adjacent trivia. Comment text remains unchanged except for configured delimiter spacing.

• Values: same_line own_line auto
• Default: auto
• Applies to: Comment-adjacent trivia.
• Guarantee: Comment text remains unchanged except for configured delimiter spacing.

Input

/// <summary>Formats this example.</summary>
class Example // attached comment
{
    /*block comment*/
}

auto (Default)

Code unchanged.

same_line

/// <summary>Formats this example.</summary>
class Example // attached comment
{
    /*block comment*/
}
    /*block comment*/ }

own_line

/// <summary>Formats this example.</summary>
class Example // attached comment
class Example
 // attached comment
{
    /*block comment*/
}

Comment alignment

dress_comment_align = true

Aligns a comment with the code it leads, giving it the indentation that code is given. When false a comment keeps the offset its author gave it and moves with that code instead. Comment text remains unchanged.

• Values: true false
• Default: true
• Applies to: The indentation of a comment on its own line.
• Guarantee: Only indentation whitespace changes.

Input

class Example
{
    void Work()
    {
            // Explains the call below.
        Call();
    }
}

true (Default)

class Example
{
    void Work()
    {
            // Explains the call below.
        // Explains the call below.
        Call();
    }
}

false

Code unchanged.

XML documentation

Xml comment placement

dress_xml_comment_placement = attached

Controls comment-adjacent trivia. Comment text remains unchanged except for configured delimiter spacing.

• Values: attached separated
• Default: attached
• Applies to: Comment-adjacent trivia.
• Guarantee: Comment text remains unchanged except for configured delimiter spacing.

Input

/// <summary>Formats this example.</summary>
class Example // attached comment
{
    /*block comment*/
}

attached (Default)

Code unchanged.

separated

/// <summary>Formats this example.</summary>

class Example // attached comment
{
    /*block comment*/
}

Xml element layout

dress_xml_element_layout = unset

Controls comment-adjacent trivia. Comment text remains unchanged except for configured delimiter spacing.

• Values: single_line multi_line
• Default: unset (the rule makes no change unless you set it)
• Applies to: Comment-adjacent trivia.
• Guarantee: Comment text remains unchanged except for configured delimiter spacing.

Input

/// <summary>Formats this example.</summary>
class Example // attached comment
{
    /*block comment*/
}

single_line

Code unchanged.

multi_line

/// <summary>Formats this example.</summary>
/// <summary>
/// Formats this example.
/// </summary>
class Example // attached comment
{
    /*block comment*/
}