logo
Welcome to our new AbleCommerce forums. As a guest, you may view the information here. To post to this forum, you must have a registered account with us, either as a new user evaluating AbleCommerce or an existing user of the application. For all questions related to the older version of Gold and earlier, please go to AbleCommerce Gold forum. Please use your AbleCommerce username and password to Login. New Registrations are disabled.

Notification

Icon
Error
Disable style cop errors in VS 2019?
Options
Go to last post Go to first unread
Previous Topic Next Topic
Jay  
#1 Posted : Monday, April 13, 2020 11:58:03 AM(UTC)
Jay

Rank: Member

Groups: Authorized User, Developers
Joined: 11/12/2018(UTC)
Posts: 25

Thanks: 1 times
Was thanked: 4 time(s) in 3 post(s)
I'm using Visual Studio 2109 Pro to work on AbleCommerce 9 source code mods. When I build, I get a ton of these errors:

SA1650 : CSharp.Documentation : The documentation text within the param tag contains incorrectly spelled words: '[some word is doesn't like such as url]'

Does anyone know how to turn these errors off or suppress them, or at least make them warnings instead of errors so it will build successfully? I've tried googling it, but all the directions seem to be for older versions of Visual Studio and StyleCop and they don't work any more. I did try adding this line to GlobalSuppressions.cs to see if I could suppress the error for one type, but it didn't help:

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Scope = "type", Target = "CommerceBuilder.Catalog.CatalogNode")]

I still got the error for items in the CatalogNode.cs file.

I also tried right-click project, choose Properties, go to Code Analysis. The Active Rules setting is "Microsoft Managed Recommended Rules". When I click the Configure button, SA1650 is not listed.

Edited by user Monday, April 13, 2020 11:59:10 AM(UTC)  | Reason: spelling corrections
Back to top

Wanna join the discussion?! Login to your AbleCommerce Forums forum account. New Registrations are disabled.
Back to top  
Jay  
#2 Posted : Monday, April 13, 2020 2:29:07 PM(UTC)
Jay

Rank: Member

Groups: Authorized User, Developers
Joined: 11/12/2018(UTC)
Posts: 25

Thanks: 1 times
Was thanked: 4 time(s) in 3 post(s)
OK, so I poked around an searched a little more, and I figured it out. At the CommerceBuilder project level, there is already a Settings.StyleCop file. Under the Analyzers section, it starts out with:
Code:

  <Analyzers>
    <Analyzer AnalyzerId="StyleCop.CSharp.DocumentationRules">
      <Rules>
        <Rule Name="FileMustHaveHeader">
          <RuleSettings>
            <BooleanProperty Name="Enabled">False</BooleanProperty>
          </RuleSettings>
        </Rule>
[etc.]

So right after that, I added:
Code:

        <Rule Name="ElementDocumentationMustBeSpelledCorrectly">
          <RuleSettings>
            <BooleanProperty Name="Enabled">False</BooleanProperty>
          </RuleSettings>
        </Rule>

Edited by user Monday, April 13, 2020 2:31:30 PM(UTC)  | Reason: Add code tags
Back to top
thanks 2 users thanked Jay for this useful post.
Joe Payne2 on 4/14/2020(UTC), mazhar on 4/29/2020(UTC)
Users browsing this topic
Guest (2)
Forum Jump  
You cannot post new topics in this forum.
You cannot reply to topics in this forum.
You cannot delete your posts in this forum.
You cannot edit your posts in this forum.
You cannot create polls in this forum.
You cannot vote in polls in this forum.

Privacy Policy | Powered by YAF.NET 2.2.4.14 | YAF.NET © 2003-2024, Yet Another Forum.NET
This page was generated in 0.090 seconds.