Book Image

Instant StyleCop Code Analysis How-to

By : Franck Leveque
Book Image

Instant StyleCop Code Analysis How-to

By: Franck Leveque

Overview of this book

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. Instant 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. Instant 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 Instant 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.
Table of Contents (7 chapters)

Chapter 1. Instant StyleCop Code Analysis How-to

Welcome to Instant StyleCop Code Analysis How-to. If we look at how we begin development of medium and big projects, one of the first things we do is to edict base principles and among them, we define coding conventions. These rules, stating how our code must look like, are here in order to improve readability and maintainability for all developers of the team. The choices made there are fairly arbitrary and depends on the background and the likes and dislikes of the person (or the development team) who laid them down. After the project begins, it however takes a lot of time and code reviews to follow them.

This is where StyleCop comes in. In this book we will take a look at some recipes that range from a simple to advanced level, which will tell you all about StyleCop and how it is used to analyze code.