User Tools

Site Tools


coding_rules

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
coding_rules [2013/10/31 00:01] – created mhatzcoding_rules [2023/04/25 16:52] (current) – external edit 127.0.0.1
Line 3: Line 3:
  
 ===== StyleCop configuration ===== ===== StyleCop configuration =====
- 
-[[https://stylecop.codeplex.com/|StyleCop]] is an IDE plugin that checks the code style according to some rules. A complete list of rules can be found [[https://stylecop.codeplex.com/wikipage?title=ReSharper%20Fixes&referringTitle=Documentation|on this page]]. 
- 
-For Mail2Voice, here is the configuration currently used. We strongly recommend to use this configuration when submiting patches. 
- 
 <code> <code>
 <StyleCopSettings Version="105"> <StyleCopSettings Version="105">
Line 25: Line 20:
           <Value>\.g\.i\.cs$</Value>           <Value>\.g\.i\.cs$</Value>
         </CollectionProperty>         </CollectionProperty>
 +        <BooleanProperty Name="AnalyzeDesignerFiles">False</BooleanProperty>
       </ParserSettings>       </ParserSettings>
     </Parser>     </Parser>
Line 30: Line 26:
   <Analyzers>   <Analyzers>
     <Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">     <Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">
 +      <Rules>
 +        <Rule Name="FieldNamesMustNotContainUnderscore">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +      </Rules>
       <AnalyzerSettings>       <AnalyzerSettings>
         <CollectionProperty Name="Hungarian">         <CollectionProperty Name="Hungarian">
Line 79: Line 82:
         </Rule>         </Rule>
         <Rule Name="GenericTypeParametersMustBeDocumentedPartialClass">         <Rule Name="GenericTypeParametersMustBeDocumentedPartialClass">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="DocumentationMustContainValidXml">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="FileMustHaveHeader">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="FileHeaderMustShowCopyright">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="FileHeaderMustHaveCopyrightText">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="FileHeaderMustContainFileName">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="FileHeaderFileNameDocumentationMustMatchFileName">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="FileHeaderMustHaveValidCompanyText">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="FileHeaderFileNameDocumentationMustMatchTypeName">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +      </Rules>
 +      <AnalyzerSettings />
 +    </Analyzer>
 +    <Analyzer AnalyzerId="StyleCop.CSharp.OrderingRules">
 +      <Rules>
 +        <Rule Name="PropertyAccessorsMustFollowOrder">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="ElementsMustAppearInTheCorrectOrder">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +      </Rules>
 +      <AnalyzerSettings>
 +        <BooleanProperty Name="GeneratedCodeElementOrder">False</BooleanProperty>
 +      </AnalyzerSettings>
 +    </Analyzer>
 +    <Analyzer AnalyzerId="StyleCop.CSharp.MaintainabilityRules">
 +      <Rules>
 +        <Rule Name="FileMayOnlyContainASingleClass">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +      </Rules>
 +      <AnalyzerSettings />
 +    </Analyzer>
 +    <Analyzer AnalyzerId="StyleCop.CSharp.LayoutRules">
 +      <Rules>
 +        <Rule Name="ElementsMustBeSeparatedByBlankLine">
           <RuleSettings>           <RuleSettings>
             <BooleanProperty Name="Enabled">False</BooleanProperty>             <BooleanProperty Name="Enabled">False</BooleanProperty>
coding_rules.1383177671.txt.gz · Last modified: 2023/04/25 16:52 (external edit)