rspec/rules/S117/apex/rule.adoc

65 lines
1.4 KiB
Plaintext
Raw Permalink Normal View History

:identifier_capital_plural: Local variables and method parameters
:identifier: local variable and method parameter
:identifier_plural: local variables and method parameters
:identifier_or: local variable or method parameter
:regex: ^[a-z][a-zA-Z0-9_]*$
include::../rule.adoc[]
2020-06-30 10:16:44 +02:00
=== Code examples
2020-06-30 10:16:44 +02:00
==== Noncompliant code example
With the default regular expression ``{regex}``:
[source,apex,diff-id=1,diff-type=noncompliant]
2020-06-30 10:16:44 +02:00
----
public void doSomething(Integer PARAM) { // Noncompliant
Integer LOCAL; // Noncompliant
...
}
----
==== Compliant solution
2020-06-30 10:16:44 +02:00
[source,apex,diff-id=1,diff-type=compliant]
2020-06-30 10:16:44 +02:00
----
public void doSomething(Integer param) {
Integer local;
...
}
----
== Resources
=== Documentation
* Wikipedia - https://en.wikipedia.org/wiki/Naming_convention_(programming)[Naming Convention (programming)]
=== Articles & blog posts
* ApexHours - https://www.apexhours.com/salesforce-naming-conventions-best-practices/[Salesforce Naming Conventions Best Practices]
=== Related rules
* S100 - Function names should comply with a naming convention
* S101 - Class names should comply with a naming convention
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../parameters.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]