rspec/rules/S100/java/rule.adoc

60 lines
968 B
Plaintext
Raw Normal View History

== Why is this an issue?
2023-06-06 17:27:22 +02:00
Shared naming conventions allow teams to collaborate efficiently.
2023-06-06 17:27:22 +02:00
This rule raises an issue when a method name does not match a provided regular expression.
2020-06-30 10:16:44 +02:00
2023-06-06 17:27:22 +02:00
For example, with the default provided regular expression ``++^[a-z][a-zA-Z0-9]*$++``, the method:
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 10:16:44 +02:00
----
2023-06-06 17:27:22 +02:00
public int DoSomething(){...} // Noncompliant
2020-06-30 10:16:44 +02:00
----
2023-06-06 17:27:22 +02:00
should be renamed to
2020-06-30 10:16:44 +02:00
2022-02-04 17:28:24 +01:00
[source,java]
2020-06-30 10:16:44 +02:00
----
public int doSomething(){...}
----
=== Exceptions
2020-06-30 10:16:44 +02:00
2023-06-06 17:27:22 +02:00
Overriding methods are excluded.
[source,java]
2020-06-30 10:16:44 +02:00
----
2023-06-06 17:27:22 +02:00
@Override
public int Do_Something(){...} // Compliant by exception
2020-06-30 10:16:44 +02:00
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
=== Parameters
.format
****
_STRING_
----
^[a-z][a-zA-Z0-9]*$
----
Regular expression used to check the method names against
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]