Hagleitner.SoftwareDevelopmentStandards.CSharp 1.2.1

Hagleitner C# Coding Guidelines

Usage

This package includes configuration files for Visual Studio that will help you code towards Hagleitner's coding guidelines. It also installs the nuget packages StyleCop.Analyzers and Microsoft.CodeAnalysis.FxCopAnalyzers.

Contents

StyleCop

StyleCop is a static code analysis tool from Microsoft that checks C# source code for conformance to StyleCop's recommended coding styles and a subset of Microsoft's .NET Framework Design Guidelines. Following rules are enforced by StyleCop: Documentation, Layout, Maintainability, Naming, Ordering, Readability and Spacing.

FxCop

FxCop is a static code analysis tool from Microsoft that checks .NET managed code assemblies for conformance to Microsoft's .NET Framework Design Guidelines. FxCop analyzes the compiled object code, not the original source code. Following rules are enforced by FxCop: COM (Interoperability), Design, Globalization, Naming, Performance, Security, Usage, Maintainability, Portability and Reliability.

Hagleitner.editorconfig & Hagleitner.TestProjects.editorconfig

These files are added to the project when installing the nuget package. To use the defined rules create a .editorconfig file at the root level of your project. Now copy the content of either Hagleitner.editorconfig or Hagleitner.TestProjects.editorconfig (depending on the type of your project) into the created .editorconfig file. The .editorconfig file is used by the analyzers to suppress certain types of errors, warnings or messages.

VsSpellChecker.vsspell

This file is added to the project when installing the nuget package and is used by the Visual Studio Spell Checker. By opening it in Visual Studio various settings can be applied to the spell checking process. You can add new entries to the user dictionary by using 'Quick Actions and Refactorings...' and selecting 'Add to Dictionary'. These entries can be accessed in the 'Dictionary Settings' menu.

Extensions

Visual Studio Spell Checker

To use this package to full extent it is recommended to install Visual Studio Spell Checker.

Visual Studio Spell Checker is a Visual Studio editor extension that checks the spelling of comments, strings and plain text. It can be installed from within Visual Studio from the Visual Studio Marketplace. Select the online marketplace and search for "Visual Studio Spell Checker". Once found, you can download and install the extension.