rspec/rules/S1821/kotlin/rule.adoc

57 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
Nested ``++when++`` structures are difficult to understand because you can easily confuse the cases of an inner ``++when++`` as belonging to an outer statement. Therefore nested ``++when++`` statements should be avoided.
2020-06-30 12:47:33 +02:00
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
Specifically, you should structure your code to avoid the need for nested ``++when++`` statements, but if you cannot, then consider moving the inner ``++when++`` to another function.
2020-06-30 12:47:33 +02:00
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,kotlin]
2020-06-30 12:47:33 +02:00
----
fun foo(n: Int, m: Int) {
when (n) {
0 ->
when (m) { // Noncompliant; nested when
// ...
}
1 -> print("1")
else -> print("2")
}
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,kotlin]
2020-06-30 12:47:33 +02:00
----
fun foo(n: Int, m: Int) {
when (n) {
0 -> bar(m)
1 -> print("1")
else -> print("2")
}
}
fun bar(m: Int){
when(m) {
// ...
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]