df644a9db1
* Create rule S6669 * First specification * Add backticks * Add compliant and noncompliant comments * Add properties * Use standard RSPEC format for links * Change the scope to "Main" * Fix default format regex * Remove VB.NET * Add logging tag * Fix asciidoc issues --------- Co-authored-by: cristian-ambrosini-sonarsource <cristian-ambrosini-sonarsource@users.noreply.github.com> Co-authored-by: Cristian Ambrosini <cristian.ambrosini@sonarsource.com> Co-authored-by: Gregory Paidis <gregory.paidis@sonarsource.com> Co-authored-by: Gregory Paidis <115458417+gregory-paidis-sonarsource@users.noreply.github.com>
21 lines
798 B
Plaintext
21 lines
798 B
Plaintext
== Why is this an issue?
|
|
|
|
Sharing some naming conventions is a key point to make it possible for a team to efficiently collaborate.
|
|
This rule checks that the logger field or property name matches a provided regular expression.
|
|
|
|
The default regex will consider compliant the followings:
|
|
|
|
* `logger`
|
|
* ``++_logger++``
|
|
* `Logger`
|
|
* ``++_Logger++``
|
|
* `log`
|
|
* ``++_log++``
|
|
|
|
The rule supports the most popular logging frameworks:
|
|
|
|
* Nuget package - https://www.nuget.org/packages/Microsoft.Extensions.Logging[Microsoft.Extensions.Logging]
|
|
* Nuget package - https://www.nuget.org/packages/Serilog[Serilog]
|
|
* Nuget package - https://www.nuget.org/packages/Castle.Core[Castle.Core]
|
|
* Nuget package - https://www.nuget.org/packages/NLog[NLog]
|
|
* Nuget package - https://www.nuget.org/packages/log4net[log4net] |