StyleCop

Documentation

Online documentation is available here:

http://www.stylecop.com/docs/

User Guide

• A Brief History of C# Style
• Why Should We Use StyleCop?
• History of StyleCop
• Managing StyleCop Project Settings
• Sharing StyleCop Settings Across Projects
• Setting Up StyleCop MSBuild Integration
• Running StyleCop in VS2005 or VS Express
• Using File Lists
• Using StyleCop on Legacy Projects
• Rule Suppressions
• Property Headers
• List of StyleCop R# fixes
• Registry Settings for Auto-update checks
• Enabling Tracing to Investigate Performance Issues
• Downloading older version of StyleCop
• Running analysis on a mapped network drive

Developer Guide

This documentation is intended for this wishing to download and build the StyleCop source code. If you wish to write your own StyleCop rules then you need the StyleCop SDK is available separately on the Downloads tab

• HOW TO: Set up your dev box to build StyleCop
• HOW TO: Build the documentation
• HOW TO: Work on a bug
• HOW TO: Debug an issue in the unit tests
• HOW TO: Debug the Settings Editor
• HOW TO: Use F5 debugging
• HOW TO: Debug why the VSPackage ins't loading
• HOW TO: Manage Issues in Issue Tracker
• HOW TO: Get a log of the installation msi
• HOW TO: Add a new language for the documentation rules

Co-ordinators Guide

• HOW TO: Review a pull request
• HOW TO: Build an official release
• HOW TO: Update the version numbers
• HOW TO: Build and update the docs