Sha256: 261c105a667d89e560d7abd23986b4fbb1e3109bfc0f7ec46903f3cc7f4d2993

Contents?: true

Size: 1.06 KB

Versions: 15

Compression:

Stored size: 1.06 KB

Contents

# Uncommunicative Variable Name

## Introduction

An `Uncommunicative Variable Name` is a variable 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 Variable Name` checks for:

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

## Configuration

`reek`'s `Uncommunicative Variable 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 `[/^.$/, /[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. Defaults to @['_']@.|

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
reek-3.5.0 docs/Uncommunicative-Variable-Name.md
reek-3.4.1 docs/Uncommunicative-Variable-Name.md
reek-3.4.0 docs/Uncommunicative-Variable-Name.md
reek-3.3.1 docs/Uncommunicative-Variable-Name.md
reek-3.3.0 docs/Uncommunicative-Variable-Name.md
reek-3.2.1 docs/Uncommunicative-Variable-Name.md
reek-3.2 docs/Uncommunicative-Variable-Name.md
reek-3.1 docs/Uncommunicative-Variable-Name.md
reek-3.0.4 docs/Uncommunicative-Variable-Name.md
reek-3.0.3 docs/Uncommunicative-Variable-Name.md
reek-3.0.2 docs/Uncommunicative-Variable-Name.md
reek-3.0.1 docs/Uncommunicative-Variable-Name.md
reek-3.0.0 docs/Uncommunicative-Variable-Name.md
reek-2.2.1 docs/Uncommunicative-Variable-Name.md
reek-2.2.0 docs/Uncommunicative-Variable-Name.md