rspec/rules/S1312/flex/rule.adoc

20 lines
738 B
Plaintext
Raw Normal View History

2020-06-30 12:47:33 +02:00
Loggers should be:
2021-01-27 13:42:22 +01:00
* ``++private++``: not accessible outside of their parent classes. If another class needs to log something, it should instantiate its own logger.
* ``++stati{cpp}``: 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.
2020-06-30 12:47:33 +02:00
== Noncompliant Code Example
2021-01-27 13:42:22 +01:00
With the default regular expression ``++LOG(?:GER)?++``:
2020-06-30 12:47:33 +02:00
----
public const logger:ILogger = LogUtil.getLogger(MyClass);
----
== Compliant Solution
----
private static const LOG:ILogger = LogUtil.getLogger(MyClass);
----