rspec/rules/S2486/csharp/rule.adoc

67 lines
1.3 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:48:07 +02:00
When exceptions occur, it is usually a bad idea to simply ignore them. Instead, it is better to handle them properly, or at least to log them.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
This rule only reports on empty catch clauses that catch generic ``++Exception++``s.
2020-06-30 12:48:07 +02:00
=== Noncompliant code example
2020-06-30 12:48:07 +02:00
2022-02-04 17:28:24 +01:00
[source,csharp]
2020-06-30 12:48:07 +02:00
----
string text = "";
try
{
text = File.ReadAllText(fileName);
}
catch (Exception exc) // Noncompliant
{
}
----
=== Compliant solution
2020-06-30 12:48:07 +02:00
2022-02-04 17:28:24 +01:00
[source,csharp]
2020-06-30 12:48:07 +02:00
----
string text = "";
try
{
text = File.ReadAllText(fileName);
}
catch (Exception exc)
{
logger.Log(exc);
}
----
=== Exceptions
2020-06-30 12:48:07 +02:00
When a block contains a comment, it is not considered to be empty.
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Handle the exception or explain in a comment why it can be ignored.
'''
== Comments And Links
(visible only on this page)
=== on 23 Mar 2015, 10:07:39 Tamas Vajk wrote:
\[~ann.campbell.2], Could you please check this subtask?
=== on 23 Mar 2015, 11:31:17 Ann Campbell wrote:
\[~tamas.vajk], there's no need to repeat the description in the subtask when it's the same (so I've removed it). Otherwise, this looks great. :-)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]