Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NielsdeBlaauw authored Feb 3, 2019
1 parent 4cfbdd4 commit 3d5210d
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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) `<default>` 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
Expand Down

0 comments on commit 3d5210d

Please sign in to comment.