public
Description: Code smell detector for Ruby
Home | Edit | New

Uncommunicative Name

An Uncommunicative Name is a 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

Currently Uncommunicative Name checks for

  • 1-character names
  • names consisting of a single character followed by a number

Configuration

Reek’s Uncommunicative Name detector supports the Basic Smell Options, 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]*$/].
accept array of strings or regular expressions Names that will be accepted (not reported) even if they match one of the reject expressions.
Last edited by kevinrutherford, Wed Mar 04 13:17:01 -0800 2009
Home | Edit | New
Versions: