Sha256: e906a4d2ca52f19447a85b15909a8201c16c124deb4518a9762ee18aac8fd326

Contents?: true

Size: 1.03 KB

Versions: 15

Compression:

Stored size: 1.03 KB

Contents

# Uncommunicative Method Name

## Introduction

An `Uncommunicative Method Name` is a method name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

## Current Support in Reek

`Uncommunicative Method Name` checks for:

* 1-character names
* any name ending with a number
* camelCaseVariableNames

## Configuration

Reek's Uncommunicative Method Name detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:

| Option         | Value       | Effect  |
| ---------------|-------------|---------|
| `reject` | array of regular expressions | The set of regular expressions that Reek uses to check for bad names. Defaults to `[/^[a-z]$/, /[0-9]$/, /[A-Z]/]`. |
| `accept` | array of strings or regular expressions | Name that will be accepted (not reported) even if they match one of the `reject` expressions. |

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
reek-4.0.0.pre1 docs/Uncommunicative-Method-Name.md
reek-3.11 docs/Uncommunicative-Method-Name.md
reek-3.10.2 docs/Uncommunicative-Method-Name.md
reek-3.10.1 docs/Uncommunicative-Method-Name.md
reek-3.10.0 docs/Uncommunicative-Method-Name.md
reek-3.9.1 docs/Uncommunicative-Method-Name.md
reek-3.9.0 docs/Uncommunicative-Method-Name.md
reek-3.8.3 docs/Uncommunicative-Method-Name.md
reek-3.8.2 docs/Uncommunicative-Method-Name.md
reek-3.8.1 docs/Uncommunicative-Method-Name.md
reek-3.8.0 docs/Uncommunicative-Method-Name.md
reek-3.7.1 docs/Uncommunicative-Method-Name.md
reek-3.7.0 docs/Uncommunicative-Method-Name.md
reek-3.6.1 docs/Uncommunicative-Method-Name.md
reek-3.6.0 docs/Uncommunicative-Method-Name.md