https://github.com/softeq/dotnet-guidelines
A set of coding guidelines for C#, design principles, and layout rules.
https://github.com/softeq/dotnet-guidelines
code-style csharp dotnet guidelines
Last synced: 8 months ago
JSON representation
A set of coding guidelines for C#, design principles, and layout rules.
- Host: GitHub
- URL: https://github.com/softeq/dotnet-guidelines
- Owner: Softeq
- License: other
- Created: 2019-11-28T11:57:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-05T11:50:33.000Z (almost 5 years ago)
- Last Synced: 2025-03-29T16:22:38.598Z (9 months ago)
- Topics: code-style, csharp, dotnet, guidelines
- Homepage:
- Size: 92.8 KB
- Stars: 13
- Watchers: 15
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# C# Coding Guidelines
## What is this?
This document attempts to provide guidelines (or coding standards if you like) for all versions of C# that are both valuable and pragmatic. The idea behind this document is make code style consistent across the projects and inside the projects as well and guarantee predictable code quality for Softeq customers. The Guidelines are based on [Dennis Doomen guidelines](https://github.com/dennisdoomen/CSharpGuidelines).
## Rule severity
Each rule in this document has its importance level:
| Rule importance | Description |
| :---------------- | :------------------------------------------------------------------------------- |
| 1 | Guidelines that you should never skip and should be applicable to all situations |
| 2 | Recommended guidelines |
## Code Analysis
| Icon | Description |
| :---------------- | :------------------------------------------------------------------------------- |
| 
| Fully covered by Re-sharper |
| 
| Partly covered by Re-sharper |
| | If no image, rules aren't covered by Re-sharper |
## Guidelines rules naming convention
All rules must be named in the following format: **Meaningful title of the rule (SDSC-1234) \[1\]**, where
* **SDCS** is Softeq Development CSharp abbreviation.
* **1234** is the rule index which includes group index (12) and the rule index (34).
* **\[1\]** is the rule a rule severity.
## Table of contents
* [10 Class design](10_ClassDesign.md)
* [11 Member design](11_MemberDesign.md)
* [12 Miscellaneous design](12_MiscellaneousDesign.md)
* [13 Maintainability](13_Maintainability.md)
* [14 Naming](14_Naming.md)
* [16 Framework](16_Framework.md)
* [17 Documentation](17_Documentation.md)
* [18 Layout](18_Layout.md)
* [Important resources](99_ImportantResources.md)
* [DotSettings](SharedRules.DotSettings)
* [Editorconfig](SharedRules.editorconfig)