Normalize method tracing pattern - Githubissues

KhiopsML / khiops

Khiops is an AutoML suite for supervised and unsupervised learning

https://khiops.org

BSD 3-Clause Clear License

26 stars 2 forks source link

Normalize method tracing pattern #156

Open folmos-at-orange opened 7 months ago

folmos-at-orange commented 7 months ago

Description

Currently, in various methods there is the following pattern to trace them:

SomeClass::SomeMethod()
{
    boolean bTrace = false;
    // <some code>

    if (bTrace)
    {
        cout << "Some trace information" << endl;
        // ...
    }
}

This pattern allows to diagnose bugs in complex code by setting bTrace = true temporarily. The pattern is not normalized because

There are many names for the boolean flag: bTrace, bLocalTrace, bDisplay ... etc.
Some of them use const boolean while others boolean.

Questions/Ideas

Proposal:
- The trace booleans must be defined at the top of the method
- before or after a potential bOk?
- Either be called bTrace or use it as a suffix (ex. bTraceResults)
- Always be const
  - Do compilers warn a lot ?
  - We should not expect performance gains

alexisbondu commented 5 months ago

A ajouter dans le wiki dans les normes de dev + faire une autre issue de reprise de qualité de code.