zoukankan      html  css  js  c++  java
  • StyleCop

    1. Install StyleCop-4.7.49.0.msi
     
    2. Run StyleCop/Run StyleCop (Rescan All)
     
    3. Warnings
    CSharp.Ordering: All using directives must be placed inside of the namespace. > Can be turned off in the StyleCop Settings
     
    4. How do I integrate StyleCop 4.7 with Visual Studio MSBuild?
     
    The above command will download the latest stable required dlls and files and integrate style cop with your project. Build your project and any stylecop errors will be shown in the warnings section.
     
    If you want your build to succeed only if all stylecop errors are fixed, you will need to make some changes to the project file to set a boolean to not treat stylecop errors as warnings.
    Open the .csproj file for your project in notepad, and find the first PropertyGroup section within the file. Add a new tag to set the StyleCopTreatErrorsAsWarnings flag to false.

    For example:

     
    <StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings> is shown above.
     
    Issues:
    1. C# - StyleCop - SA1121: UseBuiltInTypeAlias - Readability Rules

    The code uses one of the basic C# types, but does not use the built-in alias for the type.

    Rather than using the type name or the fully-qualified type name, the built-in aliases for these types should always be used: bool, byte, char, decimal, double, short, int, long, object, sbyte, float, string, ushort, uint, ulong.

    so String.Empty is wrong (depend on above rules) and string.Empty is good.

    I do not agree :)

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

    2. How to exclude private members from StyleCop rule SA1600

    I am not very interesting with write documents for private members :)

    <AnalyzerSettings>
        <BooleanProperty Name="IncludeFields">False</BooleanProperty>
    </AnalyzerSettings>

    3. A field name in C# must not begins with an underscore.

    I do not agree :)

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

    4. By default, StyleCop does not allow variable or field names to include Hungarian notation

    How can I allow nh (NHibernate)

    <Analyzers>
        <Analyzer AnalyzerId="Microsoft.StyleCop.CSharp.NamingRules">
            <AnalyzerSettings>
                <CollectionProperty Name="Hungarian">
                    <Value>nh</Value>
                </CollectionProperty>
            </AnalyzerSettings>
        </Analyzer>
    </Analyzers>

    5. The comment must start with a single space. To ignore this error when commenting out a line of code, begin the comment with '////' rather than '//'

    <Analyzer AnalyzerId="Microsoft.StyleCop.CSharp.SpacingRules">
        <Rules>
            <Rule Name="SingleLineCommentsMustBeginWithSingleSpace">
                <RuleSettings>
                    <BooleanProperty Name="Enabled">False</BooleanProperty>
                </RuleSettings>
            </Rule>
        </Rules>
    </Analyzer>

    6. The comment is empty. Add text to the comment or remove it.

    <Analyzer AnalyzerId="StyleCop.CSharp.ReadabilityRules">
        <Rules>
            <Rule Name="CommentsMustContainText">
                <RuleSettings>
                    <BooleanProperty Name="Enabled">False</BooleanProperty>
                </RuleSettings>
            </Rule>
        </Rules>
        <AnalyzerSettings />
    </Analyzer>

    7. More rules you can found in the below url:

    http://www.stylecop.com/docs/StyleCop%20Rules.html

  • 相关阅读:
    Andorid手机振动器(Vibrator)的使用
    Log.i()的用法
    刀哥多线程现操作gcd-10-delay
    刀哥多线程全局队列gcd-09-global_queue
    刀哥多线程Barrier异步gcd-08-barrier_async
    刀哥多线程同步任务作用gcd-07-sync_task
    刀哥多线程之主队列gcd-06-main_queue
    刀哥多线程之并发队列gcd-05-dispatch_queue_concurrent
    刀哥多线程串行队列gcd-04-dispatch_queue_serial
    刀哥多线程之03GCD 常用代码
  • 原文地址:https://www.cnblogs.com/zhangpengc/p/4940060.html
Copyright © 2011-2022 走看看