68e9c93d57
* Add csharp to rule S1312 * First specification * Fix ascii * Improve description * Address comments * Add the list of supported frameworks * Add links to supported frameworks * Small fixes * Add missing closing brace * Add tag logging * Remove VB.NET * Fix code snippets --------- 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>
25 lines
821 B
Plaintext
25 lines
821 B
Plaintext
== Why is this an issue?
|
|
|
|
Loggers should be:
|
|
|
|
* ``++private++``: not accessible outside of their parent classes. If another class needs to log something, it should instantiate its own logger.
|
|
* ``++static++``: not dependent on an instance of a class (an object). When logging something, contextual information can of course be provided in the messages but the logger should be created at class level to prevent creating a logger along with each object.
|
|
* ``++const++``: created once and only once per class.
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++LOG(?:GER)?++``:
|
|
|
|
[source,flex]
|
|
----
|
|
public const logger:ILogger = LogUtil.getLogger(MyClass);
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,flex]
|
|
----
|
|
private static const LOG:ILogger = LogUtil.getLogger(MyClass);
|
|
----
|
|
|
|
include::../rspecator.adoc[] |