README.md

Cognitive Complexity Analysis

Cognitive Code Analysis is an approach to understanding and improving code by focusing on how human cognition interacts with code. It emphasizes making code more readable, understandable, and maintainable by considering the cognitive processes of the developers who write and work with the code.

"Human short-term or working memory was estimated to be limited to 7 ± 2 variables in the 1950s. A more current estimate is 4 ± 1 constructs. Decision quality generally becomes degraded once this limit of four constructs is exceeded."

Source: Human Cognitive Limitations. Broad, Consistent, Clinical Application of Physiological Principles Will Require Decision Support

Running the Analysis 🧑‍💻

The tool analyses C# files and generates cognitive complexity reports. Run the analysis using:

CognitiveCodeAnalysis [sourcePath] [options]

Arguments:

• [searchPath] - (Optional) Path to search for C# files. Defaults to the current directory.

Options:

• -c|--config <path> - Load a custom configuration file
• -r|--report-type <type> - Report type: ConsoleText (default) or Html
• -o|--output-file <path> - Output file path (defaults to cognitive-analysis-report)

Examples:

# Analyse current directory with console output
CognitiveCodeAnalysis

# Analyse a specific directory
CognitiveCodeAnalysis ./src

# Generate an HTML report
CognitiveCodeAnalysis ./src -r Html -o report.html

# Use a custom configuration file
CognitiveCodeAnalysis ./src -c my-config.json

Resources 🔗

These pages and papers provide more information on cognitive limitations and readability and the impact on the business.

• Cognitive Complexity
  • Cognitive Complexity Wikipedia
  • Cognitive Complexity and Its Effect on the Code by Emanuel Trandafir.
  • Human Cognitive Limitations. Broad, Consistent, Clinical Application of Physiological Principles Will Require Decision Support by Alan H. Morris.
  • The Magical Number 4 in Short-Term Memory: A Reconsideration of Mental Storage Capacity by Nelson Cowan
  • Neural substrates of cognitive capacity limitations by Timothy J. Buschman,a,1 Markus Siegel,a,b Jefferson E. Roy, and Earl K. Millera.
  • Code Readability Testing, an Empirical Study by Todd Sedano.
  • An Empirical Validation of Cognitive Complexity as a Measure of Source Code Understandability by Marvin Muñoz Barón, Marvin Wyrich, and Stefan Wagner.
• Halstead Complexity
  • Halstead Complexity
• Cyclomatic Complexity
  • Cyclomatic Complexity

License ⚖️

Copyright Florian Krämer

Licensed under the GPL3 license.