From 3d5210d0b438ccc5c976c172ce6c713589afda25 Mon Sep 17 00:00:00 2001 From: Niels de Blaauw Date: Sun, 3 Feb 2019 12:29:21 +0100 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 987c63e..21a556f 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,6 @@ PHP Doc Check is an automated command line tool to determine which functions and methods could use some more documentation. -[Cyclomatic Complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) is -used to find complex functions. - By default this script: - Emits a warning if there is no docblock for non trivial functions (score > 4) @@ -18,6 +15,14 @@ By default this script: You can gradually improve documenation on projects by starting with relatively high limits and slowly moving these limits down. +## Metrics + +- [Cognitive Complexity](https://www.sonarsource.com/docs/CognitiveComplexity.pdf) `` is +used to find functions that are complex to read and understand. +- [Cyclomatic Complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) is +used to find complex functions with a more traditionl algorithm. + + ## Installation ### Composer