Skip to content

Commit d0335af

Browse files
committed
Added features
1 parent 4ebf3c8 commit d0335af

File tree

1 file changed

+51
-3
lines changed

1 file changed

+51
-3
lines changed

README.md

+51-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,54 @@ Open the menu ReSharper / Options... / Exceptional to configure the extension.
1919

2020
Check out the extension in the ReSharper plugin gallery:
2121

22-
- Exceptional for ReSharper 8 in the plugin gallery
23-
- Exceptional for ReSharper 9 in the plugin gallery
24-
- Exceptional for ReSharper 10 in the plugin gallery
22+
- [Exceptional for ReSharper 8 in the plugin gallery](https://resharper-plugins.jetbrains.com/packages/Exceptional)
23+
- [Exceptional for ReSharper 9 in the plugin gallery](https://resharper-plugins.jetbrains.com/packages/Exceptional.R9)
24+
- [Exceptional for ReSharper 10 in the plugin gallery](https://resharper-plugins.jetbrains.com/packages/Exceptional.R10)
25+
26+
## Features
27+
28+
### Thrown exception not documented or caught
29+
30+
**Warning:** Exceptions thrown outside the scope of method\property that are not documented in methods xml documentation (thrown with use of throw keyword).
31+
32+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922440)
33+
34+
**Fix:** Document or catch thrown exception.
35+
36+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922441)
37+
38+
**Warning:** Exception thrown outside the scope of method\property that are not documented in methods xml documentation (thrown from another invocation).
39+
40+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922442)
41+
42+
**Fix:** Document or catch thrown exception.
43+
44+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922443)
45+
46+
### Documented exception is not thrown
47+
48+
**Warning:** Exceptions documented in XML documentation that are not thrown from method/property.
49+
50+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922445)
51+
52+
**Fix:** Remove documentation of not thrown exception.
53+
54+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922446)
55+
56+
### Catch-all clauses
57+
58+
**Warning:** General catch-all clauses should be avoided.
59+
60+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922447)
61+
62+
### Not passing inner exception
63+
64+
**Warning:** Throwing new exception from catch clause should include message and inner exception.
65+
66+
![](http://download-codeplex.sec.s-msft.com/Download?ProjectName=exceptional&DownloadId=922448)
67+
68+
### Do not throw System.Exception
69+
70+
**Warning:** Throwing System.Exception should be avoided.
71+
72+
More features to come...

0 commit comments

Comments
 (0)