Instant Stylecop Code Analysis How-to

Learn how to analyze and maintain code for your projects using StyleCop with this book and ebook

Overview

• Learn something new in an Instant! A short, fast, focused guide delivering immediate results
• Create your own custom rule for the Stylecop engine
• Check and maintain a C# coding style over your projects
• Personalize Microsoft rules to fit your needs
• Embed Stylecop analysis in your own tools

In Detail

In medium-sized and big projects, coding conventions are defined in order to improve readability and maintainability for all the developers of the team. Stylecop analyzes your code and detects coding rule violations during all the phases of your project lifecycle.

Stylecop Code Analysis How-to allows you to take advantage of the features of Stylecop by guiding you through how to configure it, how to integrate it in your project environment, and finally how to personalize it in order to fit your needs.

Stylecop Code Analysis How-to teaches you how to configure and integrate Stylecop in your programming environment. The book will do this by showing you how to configure Stylecop on the developers IDE to the continuous integration server.

You will also learn how to customize Stylecop to fit your coding style by creating new rules as well as learning how to personalize your headers file. You will also see how to embed it in your own tools, using as an example the creation of a real time analysis add-on for Monodevelop.

With Stylecop Code Analysis How-to, you will have an overview of all the required steps to successfully integrate your programming team and enforce your own coding rules.

What you will learn from this book

• Install Stylecop and use it within Visual Studio
• Fix Stylecop rule violations in your project using theResharper plugin
• Integrate Stylecop analysis in Jenkins CI and report its violations
• Customize file headers and use Visual Studio templates and snippets to avoid Stylecop violations
• Create your own custom rule for the Stylecop engine and how to include some user parameters in it
• Embed Stylecop with your own tools
• Automate Stylecop analysis using MSbuild
• Automate Stylecop analysis using the command line
• Automate Stylecop analysis using Nant

Approach

Filled with practical, step-by-step instructions and clear explanations for the most important and useful tasks.The book will take a how-to approach, focusing on recipes that demonstrate Stylecop code analysis.

Who this book is written for

Stylecop Code Analysis How-to is intended for developers and project managers who are looking for an all-encompassing overview of Stylecop to display or enforce their specific coding conventions. It is assumed that you have a minimal understanding of integration technologies such as MSBuild and Nant. You should also have some knowledge on how to program in C# and LINQ. An available version of Visual Studio 2008 professional or superior is also required to follow the first chapters of this book.