src/Analyzers/CSharp/CodeFixes/DocumentationComments/CSharpRemoveDocCommentNodeCodeFixProvider.cs - main - githubmirror/roslyn

src/Analyzers/CSharp/CodeFixes/DocumentationComments/CSharpRemoveDocCommentNodeCodeFixProvider.cs

64 строки2 KB

Cyrus Najmabadi

Use primary constructors

11 июл 2024, 21:45

11 июл 2024, 21:45f1f411e

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System.Collections.Immutable;
using System.Composition;
using System.Diagnostics.CodeAnalysis;
using Microsoft.CodeAnalysis.CodeFixes;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.DocumentationComments;

namespace Microsoft.CodeAnalysis.CSharp.DocumentationComments;

[ExportCodeFixProvider(LanguageNames.CSharp, Name = PredefinedCodeFixProviderNames.RemoveDocCommentNode), Shared]
[ExtensionOrder(After = PredefinedCodeFixProviderNames.ImplementInterface)]
[method: ImportingConstructor]
[method: SuppressMessage("RoslynDiagnosticsReliability", "RS0033:Importing constructor should be [Obsolete]", Justification = "Used in test code: https://github.com/dotnet/roslyn/issues/42814")]
internal sealed class CSharpRemoveDocCommentNodeCodeFixProvider() :
    AbstractRemoveDocCommentNodeCodeFixProvider<XmlElementSyntax, XmlTextSyntax>
{
    /// <summary>
    /// Duplicate param tag
    /// </summary>
    private const string CS1571 = nameof(CS1571);

    /// <summary>
    /// Param tag with no matching parameter
    /// </summary>
    private const string CS1572 = nameof(CS1572);

    /// <summary>
    /// Duplicate typeparam tag
    /// </summary>
    private const string CS1710 = nameof(CS1710);

    public override ImmutableArray<string> FixableDiagnosticIds { get; } = [CS1571, CS1572, CS1710];

    protected override string DocCommentSignifierToken { get; } = "///";

    protected override SyntaxTriviaList GetRevisedDocCommentTrivia(string docCommentText)
        => SyntaxFactory.ParseLeadingTrivia(docCommentText);

    protected override SyntaxTokenList GetTextTokens(XmlTextSyntax xmlText)
        => xmlText.TextTokens;

    protected override bool IsXmlWhitespaceToken(SyntaxToken token)
        => token.Kind() == SyntaxKind.XmlTextLiteralToken && IsWhitespace(token.Text);

    protected override bool IsXmlNewLineToken(SyntaxToken token)
        => token.Kind() == SyntaxKind.XmlTextLiteralNewLineToken;

    private static bool IsWhitespace(string text)
    {
        foreach (var c in text)
        {
            if (!SyntaxFacts.IsWhitespace(c))
            {
                return false;
            }
        }

        return true;
    }
}