16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
59 lines
916 B
Plaintext
59 lines
916 B
Plaintext
== Why is this an issue?
|
|
|
|
Shared naming conventions allow teams to collaborate efficiently. This rule checks that all method names match a provided regular expression.
|
|
|
|
=== Noncompliant code example
|
|
|
|
With default provided regular expression ``++^[a-z][a-zA-Z0-9]*$++``:
|
|
|
|
[source,java]
|
|
----
|
|
public int DoSomething(){...}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
public int doSomething(){...}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Overriding methods are excluded.
|
|
|
|
[source,java]
|
|
----
|
|
@Override
|
|
public int Do_Something(){...}
|
|
----
|
|
|
|
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[]
|