User Tools

Site Tools


coding_rules

Differences

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


Previous revision
coding_rules [2023/04/25 16:52] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Coding rules ======
  
 +
 +===== StyleCop configuration =====
 +<code>
 +<StyleCopSettings Version="105">
 +  <GlobalSettings>
 +    <BooleanProperty Name="AutoCheckForUpdate">False</BooleanProperty>
 +    <CollectionProperty Name="DeprecatedWords">
 +      <Value>preprocessor,pre-processor</Value>
 +      <Value>shortlived,short-lived</Value>
 +    </CollectionProperty>
 +  </GlobalSettings>
 +  <Parsers>
 +    <Parser ParserId="StyleCop.CSharp.CsParser">
 +      <ParserSettings>
 +        <CollectionProperty Name="GeneratedFileFilters">
 +          <Value>\.g\.cs$</Value>
 +          <Value>\.generated\.cs$</Value>
 +          <Value>\.g\.i\.cs$</Value>
 +        </CollectionProperty>
 +        <BooleanProperty Name="AnalyzeDesignerFiles">False</BooleanProperty>
 +      </ParserSettings>
 +    </Parser>
 +  </Parsers>
 +  <Analyzers>
 +    <Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">
 +      <Rules>
 +        <Rule Name="FieldNamesMustNotContainUnderscore">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +      </Rules>
 +      <AnalyzerSettings>
 +        <CollectionProperty Name="Hungarian">
 +          <Value>as</Value>
 +          <Value>do</Value>
 +          <Value>id</Value>
 +          <Value>if</Value>
 +          <Value>in</Value>
 +          <Value>is</Value>
 +          <Value>my</Value>
 +          <Value>no</Value>
 +          <Value>on</Value>
 +          <Value>to</Value>
 +          <Value>ui</Value>
 +        </CollectionProperty>
 +      </AnalyzerSettings>
 +    </Analyzer>
 +    <Analyzer AnalyzerId="StyleCop.CSharp.DocumentationRules">
 +      <Rules>
 +        <Rule Name="ElementsMustBeDocumented">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="PartialElementsMustBeDocumented">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="EnumerationItemsMustBeDocumented">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="ElementParametersMustBeDocumented">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="ElementReturnValueMustBeDocumented">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <Rule Name="GenericTypeParametersMustBeDocumented">
 +          <RuleSettings>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +        <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>
 +            <BooleanProperty Name="Enabled">False</BooleanProperty>
 +          </RuleSettings>
 +        </Rule>
 +      </Rules>
 +      <AnalyzerSettings />
 +    </Analyzer>
 +  </Analyzers>
 +</StyleCopSettings>
 +</code>