c5507032cc
## Review A dedicated reviewer checked the rule description successfully for: - [ ] logical errors and incorrect information - [ ] information gaps and missing content - [ ] text style and tone - [ ] PR summary and labels follow [the guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)
77 lines
2.1 KiB
Plaintext
77 lines
2.1 KiB
Plaintext
: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-z][a-zA-Z0-9]*$
|
|
|
|
include::../rule.adoc[]
|
|
|
|
=== Code examples
|
|
|
|
==== Noncompliant code example
|
|
|
|
With the default regular expression ``{regex}``:
|
|
|
|
[source,swift,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
func printSomething(param_:String){ // Noncompliant
|
|
var Text = "df" // Noncompliant
|
|
Text = Text + param_
|
|
print(Text)
|
|
}
|
|
----
|
|
|
|
==== Compliant solution
|
|
|
|
[source,swift,diff-id=1,diff-type=compliant]
|
|
----
|
|
func printSomegtthing(param:String){
|
|
var text = "df"
|
|
text = text + param
|
|
print(text)
|
|
}
|
|
----
|
|
|
|
== Resources
|
|
|
|
=== Documentation
|
|
|
|
* Microsoft - https://microsoft.github.io/swift-guide/Naming.html[Swift Guide - Naming Conventions]
|
|
* Wikipedia - https://en.wikipedia.org/wiki/Naming_convention_(programming)[Naming Convention (programming)]
|
|
|
|
=== Articles & blog posts
|
|
|
|
* Betterprogramming - https://betterprogramming.pub/naming-conventions-in-swift-4b7ca5eed4d2[Naming Conventions in Swift]
|
|
* Mobomo - https://www.mobomo.com/2017/03/naming-conventions-for-swift/[Style Guide: Swift Naming Conventions
|
|
]
|
|
|
|
=== Related rules
|
|
|
|
* S100 - Function names should comply with a naming convention
|
|
* S101 - Class names should comply with a naming convention
|
|
* S114 - Protocol names should comply with a naming convention
|
|
* S115 - Constant names should comply with a naming convention
|
|
* S116 - Field names should comply with a naming convention
|
|
* S119 - Type parameter names should comply with a naming convention
|
|
* S1642 - `struct` names should comply with a naming convention
|
|
* S2342 - Enumeration types should comply with a naming convention
|
|
* S2343 - Enumeration members 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[]
|