51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
73 lines
1.1 KiB
Plaintext
73 lines
1.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
[TestMethod]
|
|
[ExpectedException(typeof(ArgumentNullException))] // Noncompliant
|
|
public void TestNullArg()
|
|
{
|
|
//...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
[TestMethod]
|
|
public void TestNullArg()
|
|
{
|
|
bool callFailed = false;
|
|
try
|
|
{
|
|
//...
|
|
}
|
|
catch (ArgumentNullException)
|
|
{
|
|
callFailed = true;
|
|
}
|
|
Assert.IsTrue(callFailed, "Expected call to MyMethod to fail with ArgumentNullException");
|
|
}
|
|
----
|
|
|
|
or
|
|
|
|
[source,csharp]
|
|
----
|
|
[TestMethod]
|
|
public void TestNullArg()
|
|
{
|
|
Assert.ThrowsException<ArgumentNullException>(() => /*...*/);
|
|
}
|
|
----
|
|
|
|
include::../exceptions.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Replace the "ExpectedException" attribute with a throw assertion or a "try/catch" block.
|
|
|
|
|
|
=== Highlighting
|
|
|
|
ExpectedException attribute
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|