lijunle / Vsxmd

VS XML documentation -> Markdown syntax.
MIT License
217 stars 52 forks source link

Vsxmd complains about `Resources.Designer.cs` (auto-generated file) not having XML comments #94

Closed astrohart closed 2 years ago

astrohart commented 2 years ago

Hi,

This is actually a compound issue:

using System;

namespace MyApp.Properties { ///

/// A strongly-typed resource class, for looking up localized strings, etc. /// // This class was auto-generated by the StronglyTypedResourceBuilder // class via a tool like ResGen or Visual Studio. // To add or remove a member, edit your .ResX file then rerun ResGen // with the /str option, or rebuild your VS project. [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] public class Resources {

    private static global::System.Resources.ResourceManager resourceMan;

    private static global::System.Globalization.CultureInfo resourceCulture;

    [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]

    /// <summary>
    /// Constructs a new instance of <see cref="T:MyApp.Properties.Resources" /> and returns a reference to it.
    /// </summary>      
    public Resources()
    {
    }

    /// <summary>
    ///   Returns the cached ResourceManager instance used by this class.
    /// </summary>
    [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
    public static global::System.Resources.ResourceManager ResourceManager
    {
        get
        {
            if (object.ReferenceEquals(resourceMan, null))
            {
                global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("MyApp.Properties.Resources", typeof(Resources).Assembly);
                resourceMan = temp;
            }
            return resourceMan;
        }
    }

    /// <summary>
    ///   Overrides the current thread's CurrentUICulture property for all
    ///   resource lookups using this strongly typed resource class.
    /// </summary>
    [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]
    public static global::System.Globalization.CultureInfo Culture
    {
        get
        {
            return resourceCulture;
        }
        set
        {
            resourceCulture = value;
        }
    }
}

}



As you can see, there clearly ARE the XML Doc comments that the warning is complaining about.  Therefore, the issue is Vsxmd triggering erroneous warnings.
astrohart commented 2 years ago

My point in filing this issue is, that the Resources.Designer.cs file is auto-generated, and thus, fixing the things that Vsxmd is complaining about is pointless -- the file will just be regenerated on the next build, and my changes will go away.

astrohart commented 2 years ago

Can't reproduce, this only seems to be occurring in some of my solutions.