charygao/exceptionalresharper

Extension for ReSharper which analyzes thrown and documented C# exceptions and suggests improvements

Exceptional for ReSharper

Exceptional is an extension for ReSharper which analyzes thrown and documented C# exceptions and suggests improvements.

Motivation

When working with a code base - whether it is a small one or a big one - developers constantly encounter issues caused by wrong exception handling. There may be an excellent exception handling policy, but it is the developer who must execute this policy on its own code. Even with no policy defined, there are good practices on how to properly handle exceptions. This extension allows you to seamlessly apply these good practices with a couple of key strokes.

Generally, the public API should be documented and thrown exceptions should be part of this documentation. But even if documenting thrown exceptions is pretty easy, the maintenance of the code that is using a particular method or property is not. This is where this extension comes into play: The extension analyzes call sites and provides hints on exceptions thrown from that invocations. If an exception is either not caught or not documented then you will be proposed to fix this problem. The extension also checks other good practices, for example that an inner exception is provided when rethrowing a new exception.

Installation

Requires ReSharper v8.2, v9, v10 or later

• Open the ReSharper menu in Visual Studio and select Extension Manager...
• Search for Exceptional and install the extension

Open the menu ReSharper / Options... / Exceptional to configure the extension.

Check out the extension in the ReSharper plugin gallery (targets the latest R# version):

• Exceptional for ReSharper

Old versions:

• Exceptional for ReSharper 8 in the plugin gallery
• Exceptional for ReSharper 9 in the plugin gallery
• Exceptional for ReSharper 10 in the plugin gallery
• Exceptional for ReSharper 2016.1 in the plugin gallery
• Exceptional for ReSharper 2016.2 in the plugin gallery
• Exceptional for ReSharper 2016.3 in the plugin gallery

Features

Thrown exception not documented or caught

Warning: Exceptions thrown outside the scope of method\property that are not documented in methods xml documentation (thrown with use of throw keyword).

Fix: Document or catch thrown exception.

Warning: Exception thrown outside the scope of method\property that are not documented in methods xml documentation (thrown from another invocation).

Fix: Document or catch thrown exception.

Documented exception is not thrown

Warning: Exceptions documented in XML documentation that are not thrown from method/property.

Fix: Remove documentation of not thrown exception.

Catch-all clauses

Warning: General catch-all clauses should be avoided.

Not passing inner exception

Warning: Throwing new exception from catch clause should include message and inner exception.

Do not throw System.Exception

Warning: Throwing System.Exception should be avoided.

More features to come...

(This project has originally been hosted on CodePlex)