A new developer tool was released by Microsoft - it is the Source Analysis for C#.
The ultimate goal of Source Analysis is to allow you to produce elegant, consistent code that your team members and others who view your code will find highly readable. In order to accomplish this, Source Analysis does not allow its rules to be very configurable. Source Analysis takes a one-size-fits-all approach to code style, layout, and readability rules. It is highly likely that you will not agree with all of the rules and may even find some of the rules annoying at first! However, the majority of teams using this tool within Microsoft have found that after a short adjustment period, they came to appreciate the rules enforced by Source Analysis, and even began to find it difficult to read code not written in this style.
Rules that this Source Analysis checks includes:
-
Layout of elements, statements, expressions, and query clauses
-
Placement of curly brackets, parenthesis, square brackets, etc
-
Spacing around keywords and operator symbols
-
Line spacing
-
Placement of method parameters within method declarations or method calls
-
Standard ordering of elements within a class
-
Formatting of documentation within element headers and file headers
-
Naming of elements, fields and variables
-
Use of the built-in types
-
Use of access modifiers
-
Allowed contents of files
-
Debugging text
A dedicated blog for Source Analysis for C# can be found here and the tool can be downloaded here.
If you want to integrate the tool with MSBuild, an explanation can be found here.