src/Compilers/CSharp/Test/Symbol/DocumentationComments/IncludeTests.cs - main - githubmirror/roslyn

src/Compilers/CSharp/Test/Symbol/DocumentationComments/IncludeTests.cs
142 строки5 KB
Rikki Gibson
SingleLineNamespace -> FileScopedNamespace (#54308)
24 июн 2021, 00:40
24 июн 2021, 00:4050a8f19
// 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.

#nullable disable

using System.Linq;
using Microsoft.CodeAnalysis.CSharp.Symbols;
using Microsoft.CodeAnalysis.CSharp.Test.Utilities;
using Roslyn.Test.Utilities;
using Xunit;

namespace Microsoft.CodeAnalysis.CSharp.UnitTests
{
    public class IncludeTests : CSharpTestBase
    {
        [Theory]
        [InlineData("Field", "F:Acme.Widget.Field")]
        [InlineData(WellKnownMemberNames.StaticConstructorName, "M:Acme.Widget.#cctor")]
        [InlineData("Event", "E:Acme.Widget.Event")]
        [InlineData("Property", "P:Acme.Widget.Property")]
        [InlineData("Method", "M:Acme.Widget.Method")]
        [InlineData("NamedType", "T:Acme.Widget.NamedType")]
        public void TestDocumentationCaching(string symbolName, string documentationId)
        {
            using var _ = new EnsureEnglishUICulture();

            var compilation = CreateCompilationWithMscorlib40AndDocumentationComments(@"namespace Acme
{
    class Widget
    {
        /// <include file=""NonExistent.xml"" />
        int Field;

        /// <include file=""NonExistent.xml"" />
        static Widget() { }

        /// <include file=""NonExistent.xml"" />
        event EventHandler Event;

        /// <include file=""NonExistent.xml"" />
        int Property { get; }

        /// <include file=""NonExistent.xml"" />
        void Method() { }

        /// <include file=""NonExistent.xml"" />
        class NamedType { }
    }
}
");

            var acmeNamespace = (NamespaceSymbol)compilation.GlobalNamespace.GetMembers("Acme").Single();
            var widgetClass = acmeNamespace.GetTypeMembers("Widget").Single();

            var symbol = widgetClass.GetMembers(symbolName).Single();
            Assert.Equal(documentationId, symbol.GetDocumentationCommentId());
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <!-- Include tag is invalid --><include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: true));
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: false));
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <!-- Include tag is invalid --><include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: true));
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: false));
        }

        [Theory]
        [InlineData("Field", "F:Acme.Widget.Field")]
        [InlineData(WellKnownMemberNames.StaticConstructorName, "M:Acme.Widget.#cctor")]
        [InlineData("Event", "E:Acme.Widget.Event")]
        [InlineData("Property", "P:Acme.Widget.Property")]
        [InlineData("Method", "M:Acme.Widget.Method")]
        [InlineData("NamedType", "T:Acme.Widget.NamedType")]
        public void TestDocumentationCachingFileScopedNamespace(string symbolName, string documentationId)
        {
            using var _ = new EnsureEnglishUICulture();

            var compilation = CreateCompilationWithMscorlib40AndDocumentationComments(@"namespace Acme;

class Widget
{
    /// <include file=""NonExistent.xml"" />
    int Field;

    /// <include file=""NonExistent.xml"" />
    static Widget() { }

    /// <include file=""NonExistent.xml"" />
    event EventHandler Event;

    /// <include file=""NonExistent.xml"" />
    int Property { get; }

    /// <include file=""NonExistent.xml"" />
    void Method() { }

    /// <include file=""NonExistent.xml"" />
    class NamedType { }
}
");

            var acmeNamespace = (NamespaceSymbol)compilation.GlobalNamespace.GetMembers("Acme").Single();
            var widgetClass = acmeNamespace.GetTypeMembers("Widget").Single();

            var symbol = widgetClass.GetMembers(symbolName).Single();
            Assert.Equal(documentationId, symbol.GetDocumentationCommentId());
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <!-- Include tag is invalid --><include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: true));
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: false));
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <!-- Include tag is invalid --><include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: true));
            Assert.Equal(
$@"<member name=""{documentationId}"">
    <include file=""NonExistent.xml"" />
</member>
", symbol.GetDocumentationCommentXml(expandIncludes: false));
        }
    }
}