rspec/rules/S117/go/rule.adoc

61 lines
1.2 KiB
Plaintext
Raw Permalink Normal View History

:identifier_capital_plural: Local variables and function parameters
:identifier: local variable and function parameter
:identifier_plural: local variables and function parameters
:identifier_or: local variable or function parameter
:regex: ^(_|[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,go,diff-id=1,diff-type=noncompliant]
2020-06-30 10:16:44 +02:00
----
func doSomething(my_param int) { // Noncompliant
var local_ int; // Noncompliant
...
}
----
==== Compliant solution
2020-06-30 10:16:44 +02:00
[source,go,diff-id=1,diff-type=compliant]
2020-06-30 10:16:44 +02:00
----
func doSomething(myParam int) {
var local int;
...
}
2020-06-30 10:16:44 +02:00
----
== Resources
=== Documentation
* Go documentation - https://go.dev/doc/effective_go#names[Effective Go - Names]
* Wikipedia - https://en.wikipedia.org/wiki/Naming_convention_(programming)[Naming Convention (programming)]
=== Related rules
* S100 - Function 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[]