forks
/
dexed
mirror of https://gitlab.com/basile.b/dexed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc

This commit is contained in:
Basile Burg 2016-12-28 10:16:01 +01:00
parent 4d5fdc1d9c
commit 17873dff77
No known key found for this signature in database
GPG Key ID: 1868039F415CB8CF
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/features_runnables.md
View File

@ -18,7 +18,7 @@ A runnable is useful to quickly test an idea, learn how to use new libraries, or
#### Shebang line #### Shebang line
By default runnables don't need any setting however the shebang line can be used when specific compiler options are required. By default runnables don't need any setting however the shebang line can be used when specific compiler options are required.
Two typical scenario: Two typical scenarios:
- the runnable will be debugged so DWARF information must be generated with `-g`. - the runnable will be debugged so DWARF information must be generated with `-g`.
- the runnable must be linked with a C static library so the linker flag `-L-lthelib` must be specified. - the runnable must be linked with a C static library so the linker flag `-L-lthelib` must be specified.

10
docs/options_code_metrics.md
View File

@ -11,7 +11,7 @@ In general several metrics exist:
* [Halstead complexity](https://en.wikipedia.org/wiki/Halstead_complexity_measures): quality indicator based on the count of operators and operands. * [Halstead complexity](https://en.wikipedia.org/wiki/Halstead_complexity_measures): quality indicator based on the count of operators and operands.
* [Cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity): quality indicator based on the program execution flow. * [Cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity): quality indicator based on the program execution flow.
Coedit implements the Halstead metric. The other may be added in a further version. Coedit implements the Halstead metric. The others may be added in a further version.
#### Halstead complexity #### Halstead complexity
@ -35,7 +35,7 @@ void foo()
} }
``` ```
Even if the SLOC count is the same. even if the SLOC count is the same.
The verification is launched from the _File_ menu, _View Halstead metrics_. The verification is launched from the _File_ menu, _View Halstead metrics_.
Each free function and member function of the module that has the focus is measured. Each free function and member function of the module that has the focus is measured.
@ -47,9 +47,9 @@ When thresholds are crossed warnings are emitted. There is 3 possible warnings:
Warnings are informative. They should simply be interpreted as an indicator that a function must be more tested or refactorized. Warnings are informative. They should simply be interpreted as an indicator that a function must be more tested or refactorized.
It's important to note that the limits of the measure: It's important to note the limits of the measure:
* even with D embedded unit test, the measure is not able to detect that a complex function is well tested. * even with D embedded unit tests, the measure is not able to detect that a complex function is well tested.
* the evolution of the quality over the time is not followed-up. * the evolution of the quality over the time is not followed-up.
* results are only relevant with the _imperative_ and _object oriented_ programming paradigm. Template Meta Programming will give wrong results. UFCS chain are not detected as consecutive calls. * results are only relevant with the _imperative_ and _object oriented_ programming paradigm. Template Meta Programming will give wrong results. UFCS chain are not detected as consecutive calls.
@ -57,4 +57,4 @@ Default values can be modified in the option editor:
![](img/code_metrics.png) ![](img/code_metrics.png)
The maximal volume of a module is not verified, simply because it's possible to have huge modules with many high quality small functions. The maximal volume of a module is not verified, simply because it's possible to have huge modules with many small functions of high quality.