rspec/rules/S1312/flex/rule.adoc
2022-02-04 16:28:24 +00:00

39 lines
1.0 KiB
Plaintext

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);
----
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[]