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.
65 lines
1.3 KiB
Plaintext
65 lines
1.3 KiB
Plaintext
include::../rule.adoc[]
|
|
|
|
For example, with the default provided regular expression ``++^[a-z][a-zA-Z0-9]*$++``, the function:
|
|
|
|
[source,php]
|
|
----
|
|
function DoSomething(){ // Noncompliant
|
|
// ...
|
|
}
|
|
----
|
|
|
|
should be renamed to
|
|
|
|
[source,php]
|
|
----
|
|
function doSomething(){
|
|
// ...
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Methods with an ``++@inheritdoc++`` annotation, as well as magic methods (``++__construct()++``, ``++__destruct()++``, ``++__call()++``, ``++__callStatic()++``, ``++__get()++``, ``++__set()++``, ``++__isset()++``, ``++__unset()++``, ``++__sleep()++``, ``++__wakeup()++``, ``++__toString()++``, ``++__invoke()++``, ``++__set_state()++``, ``++__clone()++``, ``++__debugInfo()++``) are ignored.
|
|
|
|
|
|
[source,php]
|
|
----
|
|
function __construct(){...} // Compliant by exception
|
|
function __destruct(){...} // Compliant by exception
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
function myFunc(){...} // Compliant by exception
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^[a-z][a-zA-Z0-9]*$
|
|
----
|
|
|
|
Regular expression used to check the [method|function|subroutine] names against
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|