LibrarySites.Banner

Repost: Cool Code Styling and Documentation Tools

This blog post describes some tools that you can use to enforce code and documentation quality checks for solutions using the Sitecore ASP.NET CMS.

This is a repost of http://sitecorejohn.spaces.live.com/blog/cns!960125F1D4A59952!176.entry.

Update: this repost is obsolete. For an updated version, see my newer post, Cool Tools for Sitecore ASP.NET CMS Developers.

I am strongly interested in programmer productivity and practices, including coding standards and cool tools for developers. Most Sitecore developers are aware of JetBrains ReSharper for Microsoft Visual Studio. Recently a colleague introduced me to some tools that enforce aspects of Sitecore documentation, syntax, styling, and other standards. It should be possible to customize them as desired. The tools include:

I haven't had a chance to truly explore these tools, and I have little understanding of which features come from Visual Studio, Resharper, StyleCop, StypeCop for Resharper, Agent Smith, or Agent Johnson, but as someone who researches and writes documentation almost full time, I appreciate the suggestions these tools integrate into the development environment. I will try to describe specifics as I encounter them while writing and refactoring code. At the very least, various rules help to keep lines very short, which is great for writing documentation, but should also simplify refactoring.