Skip to content

Consider word wrapping triple slash comments #44

Open

Description

@carlossanlop

Requested by @adamsitnik

Activity

  1. carlossanlop commented on Mar 5, 2021

    @carlossanlop
    ContributorAuthor

    Fixing this is not as straightforward as just splitting the line when reaching the maximum number of characters - if we happen to be in the middle of an xml element (like a <see cref="..." />, or in the middle of a word, the tool has to be smart enough to find the last whitespace character or sentence dividing character (dot, comma, colon, semicolon, etc.) and split the text line there instead.

    I'll consider this request low priority because I want to avoid breaking the build as much as possible with the ported comments, and splitting a cref accidentally will cause a build break.

    For future reference, the line splitting code will have to be added here:

    https://github.com/carlossanlop/DocsPortingTool/blob/9f567bdb93ba1f5a53831c22479b9ec826e60617/Libraries/RoslynTripleSlash/TripleSlashSyntaxRewriter.cs#L715-L716

  2. added 4 commits that reference this issue on Sep 7, 2021
    5a29567
    701ddbf
    f901133
    944bb88
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions