coding_rules
This is an old revision of the document!
Coding rules
StyleCop configuration
StyleCop is an IDE plugin that checks the code style according to some rules. A complete list of rules can be found on this page.
For Mail2Voice, here is the configuration currently used. We strongly recommend to use this configuration when submiting patches.
<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> </ParserSettings> </Parser> </Parsers> <Analyzers> <Analyzer AnalyzerId="StyleCop.CSharp.NamingRules"> <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> </Rules> <AnalyzerSettings /> </Analyzer> </Analyzers> </StyleCopSettings>
coding_rules.1383177671.txt.gz · Last modified: 2023/04/25 16:52 (external edit)