用 roslyn fix 替换评论（在正确的地方添加琐事）答案

【问题标题】：replacing comments with roslyn fix (adding trivia in the correct place)用 roslyn fix 替换评论（在正确的地方添加琐事）
【发布时间】：2015-11-11 10:50:03
【问题描述】：

鉴于以下“代码修复”
我正在尝试替换属性的文档元素，并将其替换为我的快速修复文档。

我正在努力解决琐事

    private Task<Document> AddDocumentationAsync(CodeFixContext context, SyntaxNode root, DocumentationCommentTriviaSyntax xmlElementSyntax)
    {
        const string comment = "THIS IS THE NEW COMMENT";
        var text =
            SyntaxFactory.XmlText(SyntaxFactory.TokenList(
                SyntaxFactory.XmlTextLiteral(
                    SyntaxFactory.TriviaList(),
                    comment,
                    comment,
                    SyntaxFactory.TriviaList())));

        var textList = SyntaxFactory.List<XmlNodeSyntax>(new[] {text});
        XmlNodeSyntax[] nodes = new XmlNodeSyntax[]
        {
            SyntaxFactory.XmlElement(
                SyntaxFactory.XmlElementStartTag(SyntaxFactory.XmlName("summary")),
                textList,
                SyntaxFactory.XmlElementEndTag(SyntaxFactory.XmlName("summary"))),
        };
        var list = SyntaxFactory.List<XmlNodeSyntax>(nodes);
        var newDocumentation = SyntaxFactory.DocumentationCommentTrivia(
            SyntaxKind.SingleLineDocumentationCommentTrivia,
            list);

        var spaced = newDocumentation.WithTriviaFrom(xmlElementSyntax);
        var n1 = root.ReplaceNode(xmlElementSyntax, spaced);

        var newDocument = context.Document.WithSyntaxRoot(n1);
        return Task.FromResult(newDocument);
    }

我得到这个输出。

如何保证<summary前有空格，换行符在正确位置，public string换行。即

    /// <summary>
    /// THIS IS THE NEW COMMENT
    /// </summary>
    public string Test { get; set; }

我的注册码是这样的。

    var documentationStructure = node.GetDocumentationCommentTriviaSyntax();
    var xmlElementSyntax = documentationStructure;
    var action = CodeAction.Create("Create XML Documentation", c => this.AddDocumentationAsync(context, root, xmlElementSyntax), "Create XML Documentation");
    context.RegisterCodeFix(
        action,
        diagnostic);

【问题讨论】：

您从方法声明行的开头开始，并在那里插入您的注释。您也可以插入换行符，您是否尝试过在评论 decl 的末尾插入换行符？您可以通过在文档结构中查找换行符来弄清楚如何做到这一点...
我尝试了几种组合，但无法正确回答。
不要手动执行所有这些操作 - 只需使用 .WithAdditionalAnnotations 将 Formatter.Annotation 添加到您的 XML 中。当 Code Fix 执行时，它会寻找这些注解并适当地格式化它们。

标签： c# visual-studio-2015 roslyn roslyn-code-analysis

【解决方案1】：

您需要在评论中添加EndOfDocumentationCommentToken 标记。您可以尝试以下方法：.WithEndOfComment(SyntaxFactory.Token(SyntaxKind.EndOfDocumentationCommentToken))。

顺便说一句，您可以查看this online tool 以供参考。

【讨论】：

那个在线工具，该死的，我要使用它。