Just sharing some of my inconsequential lunch conversations with you... RSS  

Friday, May 23, 2008

Microsoft Source Analysis for C#

Great little tool. Here's it is:

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.


Specifically, these rules cover the following, in no particular order:

  • 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

Source Analysis for C# can be downloaded here: https://code.msdn.microsoft.com/Release/ProjectReleases.aspx?ProjectName=sourceanalysis.

I've tried it with some LINQ sources, and got this annoying violation:

SA1513: Statements or elements wrapped in curly brackets must be followed by a blank line.

Ok, fair is fair, this was a inner select and this tool predates LINQ. Cool tool.

No comments:

Development Catharsis :: Copyright 2006 Mário Romano