2023-05-03 11:06:20 +02:00
== Why is this an issue?
2020-06-30 12:47:33 +02:00
Loggers should be:
2020-06-30 14:49:38 +02:00
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.
2021-01-27 16:55:38 +01:00
* ``++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.
2021-01-27 13:42:22 +01:00
* ``++const++``: created once and only once per class.
2020-06-30 12:47:33 +02:00
2023-05-03 11:06:20 +02:00
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2021-01-27 13:42:22 +01:00
With the default regular expression ``++LOG(?:GER)?++``:
2020-06-30 14:49:38 +02:00
2022-02-04 17:28:24 +01:00
[source,flex]
2020-06-30 12:47:33 +02:00
----
public const logger:ILogger = LogUtil.getLogger(MyClass);
----
2023-05-03 11:06:20 +02:00
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,flex]
2020-06-30 12:47:33 +02:00
----
private static const LOG:ILogger = LogUtil.getLogger(MyClass);
----
2021-06-02 20:44:38 +02:00
2024-03-12 13:59:26 +01:00
include::../rspecator.adoc[]