Checklist for high quality websites part 2

Jan 28, 2009

In the first part of the checklist, we looked at creating high quality websites from a client perspective and the tools that helps us do that. In this part we look at the (free) tools that will help us build high quality on the server side of the website.

Code quality

Treat compiler warnings as errors

When you compile your solution in Visual Studio it will by default allow compiler warnings. Compiler warning occurs when there is a problem with the code, but nothing that will result in severe errors. Such a warning could be if you have declared a variable that is never used. These warnings should at all times be treated as errors since they allow you to produce bad code. Keyvan has written a post about how to treat compiler warnings as errors.

StyleCop

The StyleCop Visual Studio add-in analyses your C# code and validates it against a lot of rules. The purpose of the tool is to force you to build maintainable, well documented code using consistent syntax and naming conventions. I’ve found that most of the rules are for maintainability and consistency. After using StyleCop on my latest project I will never build a C# project again without it.
 
Some of the rules might seem strange at first glance, but when you give it a closer look you’ll find that it actually makes a lot of sense.

FxCop

This tool should be familiar to most .NET developers by now. It has existed for a long time and is now on version 1.36. FxCop doesn’t analyze your C# code but the compiled MSIL code, so it can be used with any .NET language. Some of the rules are the same as in StyleCop, but it also actually helps you write more robust methods that result in fewer errors.

If you use StyleCop and do proper unit testing, then you might not need FxCop, but it’s always a good idea to run it on your assemblies. Here's a guide to using FxCop in website projects. Just in case. If you own a Visual Studio Team Edition, then you already have FxCop build in.

Security

Anti-Cross site Scripting (XSS) Library

The Anti-XSS library by Microsoft is not just a fancy way to HTML encode text strings entered by users. It uses white-listing which is much more secure than just trust any input and then HTML encode it in the response. It works with JavaScript, HTML elements and even HTML attributes.

Code Analysis Tool .NET (CAT.NET)

When your website relies on cookies, URL parameters or forms then it’s open for attacks. That’s because all three of them is very easy to forge and manipulate by hackers and robots even. By using the CAT.NET add-in for Visual Studio you can now easily analyze the places in your mark-up and code-behind that is vulnerable to those kinds of attacks. CAT.NET analyzes your code and tells you exactly what the problem is. It’s easy to use, understand and it lets you build more secure websites.

* $4.95/month ASP.NET Hosting with FREE SQL 2012 DB! – Click Here!

Comments (11) -

Brian Kim
Brian Kim United States
1/28/2009 9:38:50 PM #

Thanks for great post.
This series is really helpful. Will there be part 3?

Jesper Lind
Jesper Lind Sweden
1/28/2009 10:09:42 PM #

Have anybody used the AntiXss 3? Please help if somebody knows the trick.

Marwan
Marwan Tunisia
1/28/2009 11:10:38 PM #

thanks,
NDepend also is a great tool for analysing assemblies, it gives a lot of useful graphs and charts.

Mark Kordon
Mark Kordon Denmark
1/29/2009 4:36:04 AM #

I would really love to see StyleCop for VB :p

Great post, though!

Mads Kristensen
Mads Kristensen Denmark
1/29/2009 6:17:22 AM #

@Marwan,

NDepend is unfortunately not free. You can download a trial but it has less features and expires after a few months. The checklist only features free tools.

Josh Delong
Josh Delong United States
1/29/2009 11:48:16 PM #

I've been using StyleCop for almost a year now when I started a new project and it has been awesome for code sharing. I've tried to stress the importance and benefits that StyleCop offers but they just don't seem to listen.

Another tool I like to use is Resharper but I like the add-on for Cyclometric complexity. Everybody thinks I'm weird when I've got a method that's over a specific limit and I'm trying to figure out how to refactor it more.

Anyway great post Mads and keep up the good advice.

Kabon
Kabon United States
1/30/2009 1:26:52 PM #

Hi.. i have a same problems with jasper AntiXss 3. Nice to know you Mads. Just following you on twitter

Amer Gerzic
Amer Gerzic United States
2/1/2009 1:57:07 PM #

Very useful ... thanks!

Dityo Nurasto
Dityo Nurasto Indonesia
2/2/2009 2:49:13 PM #

Thanks for the post. StyleCop would help me a lot.

Nebbercracker
Nebbercracker United States
2/6/2009 10:47:50 AM #

I wish there was StyleCop for VB also Frown

shengwei Mao
shengwei Mao People's Republic of China
4/7/2009 1:15:42 AM #

easy to use
thank u

Pingbacks and trackbacks (2)+

Comments are closed

About the author

Mads Kristensen

Mads Kristensen
Program Manager at the Microsoft Web Platform team and founder of BlogEngine.NET.

More...

Month List

Disclaimer

The opinions expressed herein are my own personal opinions and do not represent my employer’s view in any way.