rspec/rules/S117/why-is-this-an-issue.adoc
nicolas-gauthier-sonarsource c5507032cc
Modify S117: Migrate to LaYC (#3263)
## 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)
2023-10-17 09:45:51 +02:00

9 lines
652 B
Plaintext

== Why is this an issue?
A naming convention in software development is a set of guidelines for naming code elements like variables, functions, and classes. +
{identifier_capital_plural} hold the meaning of the written code. Their names should be meaningful and follow a consistent and easily recognizable pattern. +
Adhering to a consistent naming convention helps to make the code more readable and understandable, which makes it easier to maintain and debug.
It also ensures consistency in the code, especially when multiple developers are working on the same project.
This rule checks that {identifier} names match a provided regular expression.